Uses of Interface
org.apache.wiki.api.core.Engine
Packages that use Engine
Package
Description
The chief package of JSPWiki.
JSPWiki's central API.
JSPWiki's Engine's component related classes.
Filter's API package of JSPWiki.
Plugin's API package of JSPWiki.
Page Providers' API package of JSPWiki.
JSPWiki's SPI package.
Attachment management, uploading and downloading.
Authentication, Authorization and the third A thing.
Access Control List implementation.
Authorizer implementation.
Provides the different login modules that JSPWiki uses.
Provides a cache abstraction for JSPWiki.
Provides page and content filtering functionality for JSPWiki.
HTML to wiki syntax translation related classes.
I18n related classes.
Entry point for JSPWiki's Page Objects.
Provides plugins to the JSPWiki.
Provides storage for JSPWiki.
Provides the JSPWiki track of pages' references.
Provides the JSPWiki rendering functionality.
Provides the JSPWiki RSS feeds functionality.
Provides the JSPWiki search functionality.
Java classes for management of the JSP user interface.
Contains classes for the JSPWiki administrative interface.
Provides the URL generation routines.
-
Uses of Engine in org.apache.wiki
Classes in org.apache.wiki that implement EngineMethods in org.apache.wiki that return EngineModifier and TypeMethodDescriptionWikiBackgroundThread.getEngine()
Returns the Engine that created this background thread.Methods in org.apache.wiki with parameters of type EngineModifier and TypeMethodDescriptionprotected 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.static WatchDog
WatchDog.getCurrentWatchDog
(Engine engine) Returns the current watchdog for the current thread.static Session
WikiSession.getWikiSession
(Engine engine, javax.servlet.http.HttpServletRequest request) Static factory method that returns the Session object associated with the current HTTP request.static Session
WikiSession.guestSession
(Engine engine) Static factory method that creates a new "guest" session containing a single user PrincipalWikiPrincipal.GUEST
, plus the role principalsRole.ALL
andRole.ANONYMOUS
.default void
WikiProvider.initialize
(Engine engine, Properties properties) Deprecated.Initializes the page provider.static void
WikiSession.removeWikiSession
(Engine 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
Deprecated.static Principal[]
WikiSession.userPrincipals
(Engine engine) Deprecated.useSessionMonitor.userPrincipals()
insteadConstructors in org.apache.wiki with parameters of type EngineModifierConstructorDescriptionCreates a new WatchDog for a Thread.Creates a new WatchDog for a Watchable.WikiBackgroundThread
(Engine 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
(Engine engine, javax.servlet.http.HttpServletRequest request, String requestContext) Creates a new WikiContext from a supplied HTTP request, using a default wiki context.WikiContext
(Engine engine, javax.servlet.http.HttpServletRequest request, Command command) Creates a new WikiContext for the given Engine, Command and HttpServletRequest.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.Create a new WikiPage using a given engine and name. -
Uses of Engine in org.apache.wiki.api.core
Methods in org.apache.wiki.api.core with type parameters of type EngineMethods in org.apache.wiki.api.core that return Engine -
Uses of Engine in org.apache.wiki.api.engine
Methods in org.apache.wiki.api.engine with parameters of type EngineModifier and TypeMethodDescriptionvoid
Initializable.initialize
(Engine engine, Properties props) Initializes this Engine component.default void
EngineLifecycleExtension.onShutdown
(Engine e, Properties properties) Called beforeEngine
shutdown.default void
EngineLifecycleExtension.onStart
(Engine e, Properties properties) Called afterEngine
initialization. -
Uses of Engine in org.apache.wiki.api.filters
Fields in org.apache.wiki.api.filters declared as EngineMethods in org.apache.wiki.api.filters with parameters of type EngineModifier and TypeMethodDescriptionvoid
Deprecated.default void
Called for every filter, e.g. on wiki engine shutdown.void
BasePageFilter.initialize
(Engine engine, Properties properties) If you override this, you should call super.initialize() first.void
PageFilter.initialize
(Engine engine, Properties properties) Is called whenever the a new PageFilter is instantiated and reset. -
Uses of Engine in org.apache.wiki.api.plugin
Methods in org.apache.wiki.api.plugin with parameters of type EngineModifier and TypeMethodDescriptionvoid
InitializablePlugin.initialize
(Engine engine) Called whenever the plugin is being instantiated for the first time. -
Uses of Engine in org.apache.wiki.api.providers
Methods in org.apache.wiki.api.providers with parameters of type EngineModifier and TypeMethodDescriptionvoid
WikiProvider.initialize
(Engine engine, Properties properties) Initializes the page provider. -
Uses of Engine in org.apache.wiki.api.spi
Methods in org.apache.wiki.api.spi that return EngineModifier and TypeMethodDescriptionEngineDSL.find
(javax.servlet.ServletConfig config) Locate, or build if necessary, a configuredEngine
instance.EngineDSL.find
(javax.servlet.ServletConfig config, Properties props) Locate, or build if necessary, a configuredEngine
instance.EngineDSL.find
(javax.servlet.ServletContext context, Properties props) Locate, or build if necessary, a configuredEngine
instance.EngineSPI.find
(javax.servlet.ServletContext context, Properties props) Locate, or build if necessary, a configuredEngine
instance.Methods in org.apache.wiki.api.spi with parameters of type EngineModifier and TypeMethodDescriptionContentsDSL.attachment
(Engine engine, String parentPage, String fileName) Creates a newAttachment
.ContentsSPI.attachment
(Engine engine, String parentPage, String fileName) Creates a newAttachment
.ContextDSL.create
(Engine engine, javax.servlet.http.HttpServletRequest request, String requestContext) Creates a new Context from a supplied HTTP request, using a default wiki context.Creates a new Context for the given Engine, Command and HttpServletRequest.Creates a new Context for the given Engine, Page and HttpServletRequest.Create a new Context for the given Page.ContextSPI.create
(Engine engine, javax.servlet.http.HttpServletRequest request, String requestContext) Creates a new Context from a supplied HTTP request, using a default wiki context.Creates a new Context for the given Engine, Command and HttpServletRequest.Creates a new Context for the given Engine, Page and HttpServletRequest.Create a new Context for the given Page.Returns the Session object associated with the current HTTP request.Returns the Session object associated with the current HTTP request.Creates a new "guest" session containing a single user Principalorg.apache.wiki.auth.WikiPrincipal#GUEST
, plus the role principalsRole#ALL
andRole#ANONYMOUS
.Creates a new "guest" session containing a single user Principalorg.apache.wiki.auth.WikiPrincipal#GUEST
, plus the role principalsRole#ALL
andRole#ANONYMOUS
.Creates aPage
instance.Creates aPage
instance.void
Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process.void
Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process. -
Uses of Engine in org.apache.wiki.attachment
Constructors in org.apache.wiki.attachment with parameters of type EngineModifierConstructorDescriptionAttachment
(Engine engine, String parentPage, String fileName) Creates a new attachment.DefaultAttachmentManager
(Engine engine, Properties props) Creates a new AttachmentManager.DynamicAttachment
(Engine engine, String parentPage, String fileName, DynamicAttachmentProvider provider) Creates a DynamicAttachment. -
Uses of Engine in org.apache.wiki.auth
Methods in org.apache.wiki.auth with parameters of type EngineModifier and TypeMethodDescriptionstatic SessionMonitor
SessionMonitor.getInstance
(Engine engine) Returns the instance of the SessionMonitor for this wiki.void
Authorizer.initialize
(Engine engine, Properties props) Initializes the authorizer.void
DefaultAuthenticationManager.initialize
(Engine engine, Properties props) Initializes this Engine component.void
DefaultAuthorizationManager.initialize
(Engine engine, Properties properties) Initializes this Engine component.void
DefaultUserManager.initialize
(Engine engine, Properties props) Initializes this Engine component.Constructors in org.apache.wiki.auth with parameters of type EngineModifierConstructorDescriptionSecurityVerifier
(Engine engine, Session session) Constructs a new SecurityVerifier for a supplied Engine and WikiSession. -
Uses of Engine in org.apache.wiki.auth.acl
Methods in org.apache.wiki.auth.acl with parameters of type EngineModifier and TypeMethodDescriptionvoid
DefaultAclManager.initialize
(Engine engine, Properties props) Initializes this Engine component. -
Uses of Engine in org.apache.wiki.auth.authorize
Fields in org.apache.wiki.auth.authorize declared as EngineModifier and TypeFieldDescriptionprotected Engine
DefaultGroupManager.m_engine
protected Engine
WebContainerAuthorizer.m_engine
Methods in org.apache.wiki.auth.authorize with parameters of type EngineModifier and TypeMethodDescriptionvoid
DefaultGroupManager.initialize
(Engine engine, Properties props) Initializes this Engine component.void
GroupDatabase.initialize
(Engine engine, Properties props) Initializes the group database based on values from a Properties object.void
JDBCGroupDatabase.initialize
(Engine engine, Properties props) Initializes the group database based on values from a Properties object.void
WebContainerAuthorizer.initialize
(Engine engine, Properties props) Initializes the authorizer for.void
XMLGroupDatabase.initialize
(Engine engine, Properties props) Initializes the group database based on values from a Properties object. -
Uses of Engine in org.apache.wiki.auth.login
Methods in org.apache.wiki.auth.login that return EngineMethods in org.apache.wiki.auth.login with parameters of type EngineModifier and TypeMethodDescriptionstatic void
CookieAuthenticationLoginModule.clearLoginCookie
(Engine 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
Sets the engine object.static void
CookieAuthenticationLoginModule.setLoginCookie
(Engine 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 EngineModifierConstructorDescriptionWebContainerCallbackHandler
(Engine engine, javax.servlet.http.HttpServletRequest request) Create a new handler.WikiCallbackHandler
(Engine engine, javax.servlet.http.HttpServletRequest request, String username, String password) Create a new callback handler. -
Uses of Engine in org.apache.wiki.auth.user
Methods in org.apache.wiki.auth.user with parameters of type EngineModifier and TypeMethodDescriptionabstract void
AbstractUserDatabase.initialize
(Engine engine, Properties props) Initializes the user database based on values from a Properties object.void
DummyUserDatabase.initialize
(Engine engine, Properties props) No-op.void
JDBCUserDatabase.initialize
(Engine engine, Properties props) void
UserDatabase.initialize
(Engine engine, Properties props) Initializes the user database based on values from a Properties object.void
XMLUserDatabase.initialize
(Engine engine, Properties props) Initializes the user database based on values from a Properties object. -
Uses of Engine in org.apache.wiki.cache
Methods in org.apache.wiki.cache with parameters of type EngineModifier and TypeMethodDescriptionvoid
EhcacheCachingManager.initialize
(Engine engine, Properties props) Initializes this Engine component. -
Uses of Engine in org.apache.wiki.diff
Methods in org.apache.wiki.diff with parameters of type EngineModifier and TypeMethodDescriptionvoid
ContextualDiffProvider.initialize
(Engine engine, Properties properties) void
DiffProvider.NullDiffProvider.initialize
(Engine engine, Properties properties) Initializes the page provider.void
ExternalDiffProvider.initialize
(Engine engine, Properties properties) Initializes the page provider.void
TraditionalDiffProvider.initialize
(Engine engine, Properties properties) Initializes the page provider.Constructors in org.apache.wiki.diff with parameters of type EngineModifierConstructorDescriptionDefaultDifferenceManager
(Engine engine, Properties props) Creates a new DifferenceManager for the given engine. -
Uses of Engine in org.apache.wiki.filters
Methods in org.apache.wiki.filters with parameters of type EngineModifier and TypeMethodDescriptionvoid
CreoleFilter.initialize
(Engine engine, Properties props) If you override this, you should call super.initialize() first.void
PageEventFilter.initialize
(Engine engine, Properties properties) Called whenever a new PageFilter is instantiated and reset.void
PingWeblogsComFilter.initialize
(Engine engine, Properties props) If you override this, you should call super.initialize() first.void
SpamFilter.initialize
(Engine engine, Properties properties) If you override this, you should call super.initialize() first.Constructors in org.apache.wiki.filters with parameters of type EngineModifierConstructorDescriptionDefaultFilterManager
(Engine engine, Properties props) Constructs a new FilterManager object. -
Uses of Engine in org.apache.wiki.htmltowiki
Constructors in org.apache.wiki.htmltowiki with parameters of type EngineModifierConstructorDescriptionCreate a new translator.XHtmlElementToWikiTranslator
(Engine e, org.jdom2.Element base) Create a new translator using the default config.XHtmlElementToWikiTranslator
(Engine e, org.jdom2.Element base, XHtmlToWikiConfig config) Create a new translator using the specified config. -
Uses of Engine in org.apache.wiki.i18n
Constructors in org.apache.wiki.i18n with parameters of type EngineModifierConstructorDescriptionConstructs a new InternationalizationManager. -
Uses of Engine in org.apache.wiki.modules
Fields in org.apache.wiki.modules declared as EngineConstructors in org.apache.wiki.modules with parameters of type Engine -
Uses of Engine in org.apache.wiki.pages
Methods in org.apache.wiki.pages that return EngineModifier and TypeMethodDescriptionprotected Engine
DefaultPageManager.getEngine()
Returns the Engine to which this PageManager belongs to.Constructors in org.apache.wiki.pages with parameters of type EngineModifierConstructorDescriptionDefaultPageManager
(Engine engine, Properties props) Creates a new PageManager. -
Uses of Engine in org.apache.wiki.parser
Fields in org.apache.wiki.parser declared as Engine -
Uses of Engine in org.apache.wiki.plugin
Fields in org.apache.wiki.plugin declared as EngineMethods in org.apache.wiki.plugin with parameters of type EngineModifier and TypeMethodDescriptionWeblogPlugin.findBlogEntries
(Engine engine, String baseName, Date start, Date end) Attempts to locate all pages that correspond to the blog entry pattern.WeblogEntryPlugin.getNewEntryPage
(Engine engine, String blogName) Returns a new page name for entries.void
PageViewPlugin.initialize
(Engine engine) Initialize the PageViewPlugin and its singleton.void
PageViewPlugin.PageViewManager.initialize
(Engine engine) Initialize the page view manager.Constructors in org.apache.wiki.plugin with parameters of type EngineModifierConstructorDescriptionDefaultPluginManager
(Engine engine, Properties props) Create a new PluginManager. -
Uses of Engine in org.apache.wiki.providers
Fields in org.apache.wiki.providers declared as EngineMethods in org.apache.wiki.providers with parameters of type EngineModifier and TypeMethodDescriptionvoid
AbstractFileProvider.initialize
(Engine engine, Properties properties) Initializes the page provider.void
BasicAttachmentProvider.initialize
(Engine engine, Properties properties) Initializes the page provider.void
CachingAttachmentProvider.initialize
(Engine engine, Properties properties) Initializes the page provider.void
CachingProvider.initialize
(Engine engine, Properties properties) Initializes the page provider.void
VersioningFileProvider.initialize
(Engine engine, Properties properties) Initializes the page provider.void
WikiAttachmentAdapterProvider.initialize
(Engine engine, Properties properties) Deprecated.Initializes the page provider.void
WikiPageAdapterProvider.initialize
(Engine engine, Properties properties) Deprecated.Initializes the page provider. -
Uses of Engine in org.apache.wiki.references
Constructors in org.apache.wiki.references with parameters of type EngineModifierConstructorDescriptionDefaultReferenceManager
(Engine engine) Builds a new ReferenceManager. -
Uses of Engine in org.apache.wiki.render
Methods in org.apache.wiki.render with parameters of type EngineModifier and TypeMethodDescriptionvoid
DefaultRenderingManager.initialize
(Engine engine, Properties properties) Initializes this Engine component. -
Uses of Engine in org.apache.wiki.rss
Methods in org.apache.wiki.rss with parameters of type EngineModifier and TypeMethodDescriptionvoid
DefaultRSSGenerator.initialize
(Engine engine, Properties properties) Initializes this Engine component.Constructors in org.apache.wiki.rss with parameters of type EngineModifierConstructorDescriptionDefaultRSSGenerator
(Engine engine, Properties properties) Builds the RSS generator for a given Engine.Create a new RSS thread. -
Uses of Engine in org.apache.wiki.search
Methods in org.apache.wiki.search that return EngineModifier and TypeMethodDescriptionprotected Engine
LuceneSearchProvider.getEngine()
Returns the handling engine.Methods in org.apache.wiki.search with parameters of type EngineModifier and TypeMethodDescriptionvoid
BasicSearchProvider.initialize
(Engine engine, Properties props) Initializes the page provider.void
DefaultSearchManager.initialize
(Engine engine, Properties properties) If you override this, you should call super.initialize() first.void
LuceneSearchProvider.initialize
(Engine engine, Properties props) Initializes the page provider.Constructors in org.apache.wiki.search with parameters of type EngineModifierConstructorDescriptionDefaultSearchManager
(Engine engine, Properties properties) Creates a new SearchManager.SearchMatcher
(Engine engine, QueryItem[] queries) Creates a new SearchMatcher. -
Uses of Engine in org.apache.wiki.search.kendra
Methods in org.apache.wiki.search.kendra with parameters of type EngineModifier and TypeMethodDescriptionvoid
KendraSearchProvider.initialize
(Engine engine, Properties properties) Initializes the page provider. -
Uses of Engine in org.apache.wiki.spi
Methods in org.apache.wiki.spi that return EngineModifier and TypeMethodDescriptionEngineSPIDefaultImpl.find
(javax.servlet.ServletContext context, Properties props) Locate, or build if necessary, a configuredEngine
instance.Methods in org.apache.wiki.spi with parameters of type EngineModifier and TypeMethodDescriptionContentsSPIDefaultImpl.attachment
(Engine engine, String parentPage, String fileName) Creates a newAttachment
.ContextSPIDefaultImpl.create
(Engine engine, javax.servlet.http.HttpServletRequest request, String requestContext) Creates a new Context from a supplied HTTP request, using a default wiki context.ContextSPIDefaultImpl.create
(Engine engine, javax.servlet.http.HttpServletRequest request, Command command) Creates a new Context for the given Engine, Command and HttpServletRequest.ContextSPIDefaultImpl.create
(Engine engine, javax.servlet.http.HttpServletRequest request, Page page) Creates a new Context for the given Engine, Page and HttpServletRequest.Create a new Context for the given Page.Returns the Session object associated with the current HTTP request.Creates a new "guest" session containing a single user Principalorg.apache.wiki.auth.WikiPrincipal#GUEST
, plus the role principalsRole#ALL
andRole#ANONYMOUS
.Creates aPage
instance.void
Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process. -
Uses of Engine in org.apache.wiki.ui
Fields in org.apache.wiki.ui declared as EngineMethods in org.apache.wiki.ui with parameters of type EngineModifier and TypeMethodDescriptionvoid
DefaultEditorManager.initialize
(Engine engine, Properties props) Initializes this Engine component.Constructors in org.apache.wiki.ui with parameters of type EngineModifierConstructorDescriptionDefaultCommandResolver
(Engine engine, Properties properties) Constructs a CommandResolver for a given Engine.DefaultEditorManager
(Engine engine) DefaultTemplateManager
(Engine engine, Properties properties) Creates a new TemplateManager.WikiRequestWrapper
(Engine engine, javax.servlet.http.HttpServletRequest request) Constructs a new wrapped request. -
Uses of Engine in org.apache.wiki.ui.admin
Fields in org.apache.wiki.ui.admin declared as EngineModifier and TypeFieldDescriptionprotected Engine
SimpleAdminBean.m_engine
Provides access to a Engine instance to which this AdminBean belongs to.Methods in org.apache.wiki.ui.admin with parameters of type EngineModifier and TypeMethodDescriptionvoid
AdminBean.initialize
(Engine engine) void
SimpleAdminBean.initialize
(Engine engine) Initialize the AdminBean by setting up a Engine instance internally.Constructors in org.apache.wiki.ui.admin with parameters of type Engine -
Uses of Engine in org.apache.wiki.ui.admin.beans
Methods in org.apache.wiki.ui.admin.beans with parameters of type EngineConstructors in org.apache.wiki.ui.admin.beans with parameters of type EngineModifierConstructorDescriptionFilterBean
(Engine engine) ModuleBean
(Engine engine) PluginBean
(Engine engine) SearchManagerBean
(Engine engine) -
Uses of Engine in org.apache.wiki.url
Fields in org.apache.wiki.url declared as EngineMethods in org.apache.wiki.url with parameters of type EngineModifier and TypeMethodDescriptionvoid
DefaultURLConstructor.initialize
(Engine engine, Properties properties) Initializes this Engine component.void
ShortURLConstructor.initialize
(Engine engine, Properties properties) Initializes this Engine component.void
ShortViewURLConstructor.initialize
(Engine engine, Properties properties) Initializes this Engine component. -
Uses of Engine in org.apache.wiki.workflow
Methods in org.apache.wiki.workflow that return EngineModifier and TypeMethodDescriptionprotected Engine
DefaultWorkflowManager.getEngine()
Protected helper method that returns the associated EngineMethods in org.apache.wiki.workflow with parameters of type EngineModifier and TypeMethodDescriptionstatic WorkflowBuilder
WorkflowBuilder.getBuilder
(Engine engine) Returns the WorkflowBuilder instance for a Engine.void
DefaultWorkflowManager.initialize
(Engine engine, Properties props) Initializes this Engine component. -
Uses of Engine in org.apache.wiki.xmlrpc
Fields in org.apache.wiki.xmlrpc declared as Engine
SessionMonitor.sessions()
instead