Uses of Class
com.ecyrd.jspwiki.WikiEngine

Packages that use WikiEngine
com.ecyrd.jspwiki The chief package of JSPWiki. 
com.ecyrd.jspwiki.attachment Attachment management, uploading and downloading. 
com.ecyrd.jspwiki.auth Authentication, Authorization and the third A thing. 
com.ecyrd.jspwiki.auth.acl Access Control List implementation. 
com.ecyrd.jspwiki.auth.authorize Authorizer implementation. 
com.ecyrd.jspwiki.auth.login Provides the different login modules that JSPWiki uses. 
com.ecyrd.jspwiki.auth.user   
com.ecyrd.jspwiki.content Provides content management functionality for JSPWiki. 
com.ecyrd.jspwiki.dav   
com.ecyrd.jspwiki.diff   
com.ecyrd.jspwiki.event   
com.ecyrd.jspwiki.filters Provides page and content filtering functionality for JSPWiki. 
com.ecyrd.jspwiki.i18n   
com.ecyrd.jspwiki.modules   
com.ecyrd.jspwiki.parser   
com.ecyrd.jspwiki.plugin Provides plugins to the JSPWiki. 
com.ecyrd.jspwiki.providers Provides storage for JSPWiki. 
com.ecyrd.jspwiki.render   
com.ecyrd.jspwiki.rss   
com.ecyrd.jspwiki.search Provides the JSPWiki search functionality. 
com.ecyrd.jspwiki.ui Java classes for management of the JSP user interface. 
com.ecyrd.jspwiki.ui.admin Contains classes for the JSPWiki administrative interface. 
com.ecyrd.jspwiki.ui.admin.beans   
com.ecyrd.jspwiki.url Provides the URL generation routines. 
com.ecyrd.jspwiki.util Provides a number of utility libraries that are of general use. 
com.ecyrd.jspwiki.workflow   
com.ecyrd.jspwiki.xmlrpc   
 

Uses of WikiEngine in com.ecyrd.jspwiki
 

Methods in com.ecyrd.jspwiki that return WikiEngine
 WikiEngine WikiContext.getEngine()
          Returns the handling engine.
 WikiEngine PageManager.getEngine()
          Returns the WikiEngine to which this PageManager belongs to.
static WikiEngine WikiEngine.getInstance(ServletConfig config)
          Gets a WikiEngine related to this servlet.
static WikiEngine WikiEngine.getInstance(ServletConfig config, Properties props)
          Gets a WikiEngine related to the servlet.
static WikiEngine WikiEngine.getInstance(ServletContext context, Properties props)
          Gets a WikiEngine related to the servlet.
 

Methods in com.ecyrd.jspwiki with parameters of type WikiEngine
protected static Command WikiContext.findCommand(WikiEngine engine, HttpServletRequest request, WikiPage page)
          Looks up and returns a PageCommand based on a supplied WikiPage and HTTP request.
protected static Collection TranslatorReader.getImagePatterns(WikiEngine engine)
          Deprecated. Figure out which image suffixes should be inlined.
static WikiSession WikiSession.getWikiSession(WikiEngine engine, 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, 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 com.ecyrd.jspwiki with parameters of type WikiEngine
PageManager(WikiEngine engine, Properties props)
          Creates a new PageManager.
ReferenceManager(WikiEngine engine)
          Builds a new ReferenceManager.
SearchMatcher(WikiEngine engine, QueryItem[] queries)
          Creates a new SearchMatcher.
WikiContext(WikiEngine engine, HttpServletRequest request, Command command)
           Creates a new WikiContext for the given WikiEngine, Command and HttpServletRequest.
WikiContext(WikiEngine engine, 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 com.ecyrd.jspwiki.attachment
 

Constructors in com.ecyrd.jspwiki.attachment with parameters of type WikiEngine
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 com.ecyrd.jspwiki.auth
 

Methods in com.ecyrd.jspwiki.auth with parameters of type WikiEngine
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 AuthorizationManager.initialize(WikiEngine engine, Properties properties)
          Initializes AuthorizationManager with an engine and set of properties.
 void AuthenticationManager.initialize(WikiEngine engine, Properties props)
          Creates an AuthenticationManager instance for the given WikiEngine and the specified 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 com.ecyrd.jspwiki.auth with parameters of type WikiEngine
SecurityVerifier(WikiEngine engine, WikiSession session)
          Constructs a new SecurityVerifier for a supplied WikiEngine and WikiSession.
UserManager.SaveUserProfileTask(WikiEngine engine)
          Constructs a new Task for saving a user profile.
 

Uses of WikiEngine in com.ecyrd.jspwiki.auth.acl
 

Methods in com.ecyrd.jspwiki.auth.acl with parameters of type WikiEngine
 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 com.ecyrd.jspwiki.auth.authorize
 

Fields in com.ecyrd.jspwiki.auth.authorize declared as WikiEngine
protected  WikiEngine GroupManager.m_engine
           
protected  WikiEngine WebContainerAuthorizer.m_engine
           
 

Methods in com.ecyrd.jspwiki.auth.authorize with parameters of type WikiEngine
 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 GroupDatabase.initialize(WikiEngine engine, Properties props)
          Initializes the group database based on values from a Properties object.
 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 com.ecyrd.jspwiki.auth.login
 

Methods in com.ecyrd.jspwiki.auth.login that return WikiEngine
 WikiEngine WikiEngineCallback.getEngine()
          Returns the engine.
 

Methods in com.ecyrd.jspwiki.auth.login with parameters of type WikiEngine
static void CookieAuthenticationLoginModule.clearLoginCookie(WikiEngine engine, HttpServletRequest request, 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, HttpServletResponse response, String username)
          Sets a login cookie based on properties set by the user.
 

Constructors in com.ecyrd.jspwiki.auth.login with parameters of type WikiEngine
WebContainerCallbackHandler(WikiEngine engine, HttpServletRequest request)
          Create a new handler.
WikiCallbackHandler(WikiEngine engine, HttpServletRequest request, String username, String password)
          Create a new callback handler.
 

Uses of WikiEngine in com.ecyrd.jspwiki.auth.user
 

Methods in com.ecyrd.jspwiki.auth.user with parameters of type WikiEngine
 void UserDatabase.initialize(WikiEngine engine, Properties props)
          Initializes the user database based on values from a Properties object.
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 XMLUserDatabase.initialize(WikiEngine engine, Properties props)
          Initializes the user database based on values from a Properties object.
 

Uses of WikiEngine in com.ecyrd.jspwiki.content
 

Methods in com.ecyrd.jspwiki.content with parameters of type WikiEngine
 void Exporter.export(WikiEngine engine)
          Exports the entire repository using a WikiEngine.
protected  void Exporter.exportPage(WikiEngine engine, Attachment att)
           
protected  void Exporter.exportPage(WikiEngine engine, WikiPage p)
           
 

Uses of WikiEngine in com.ecyrd.jspwiki.dav
 

Fields in com.ecyrd.jspwiki.dav declared as WikiEngine
protected  WikiEngine AttachmentDavProvider.m_engine
           
protected  WikiEngine WikiDavProvider.m_engine
           
 

Methods in com.ecyrd.jspwiki.dav that return WikiEngine
 WikiEngine AttachmentDavProvider.getEngine()
          Returns the engine used by this provider.
 WikiEngine WikiDavProvider.getEngine()
           
 

Constructors in com.ecyrd.jspwiki.dav with parameters of type WikiEngine
AttachmentDavProvider(WikiEngine engine)
           
HTMLPagesDavProvider(WikiEngine engine)
           
RawPagesDavProvider(WikiEngine engine)
           
WikiDavProvider(WikiEngine engine)
           
WikiRootProvider(WikiEngine engine)
           
 

Uses of WikiEngine in com.ecyrd.jspwiki.diff
 

Methods in com.ecyrd.jspwiki.diff with parameters of type WikiEngine
 void DiffProvider.NullDiffProvider.initialize(WikiEngine engine, Properties properties)
          Initializes the page provider.
 void ContextualDiffProvider.initialize(WikiEngine engine, Properties properties)
           
 void ExternalDiffProvider.initialize(WikiEngine engine, Properties properties)
          Initializes the page provider.
 void TraditionalDiffProvider.initialize(WikiEngine engine, Properties properties)
          Initializes the page provider.
 

Constructors in com.ecyrd.jspwiki.diff with parameters of type WikiEngine
DifferenceManager(WikiEngine engine, Properties props)
          Creates a new DifferenceManager for the given engine.
 

Uses of WikiEngine in com.ecyrd.jspwiki.event
 

Methods in com.ecyrd.jspwiki.event that return WikiEngine
 WikiEngine WikiEngineEvent.getEngine()
          Returns the WikiEngine that spawned this event.
 WikiEngine WikiEngineEvent.getWikiEngine()
          Deprecated. use WikiEngineEvent.getEngine() instead.
 

Uses of WikiEngine in com.ecyrd.jspwiki.filters
 

Fields in com.ecyrd.jspwiki.filters declared as WikiEngine
protected  WikiEngine BasicPageFilter.m_engine
           
 

Methods in com.ecyrd.jspwiki.filters with parameters of type WikiEngine
 void BasicPageFilter.destroy(WikiEngine engine)
          Called for every filter, e.g. on wiki eingine shutdown.
 void PageFilter.destroy(WikiEngine engine)
          Called for every filter, e.g. on wiki eingine 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.
 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.
 

Constructors in com.ecyrd.jspwiki.filters with parameters of type WikiEngine
FilterManager(WikiEngine engine, Properties props)
          Constructs a new FilterManager object.
 

Uses of WikiEngine in com.ecyrd.jspwiki.i18n
 

Constructors in com.ecyrd.jspwiki.i18n with parameters of type WikiEngine
InternationalizationManager(WikiEngine engine)
          Constructs a new InternationalizationManager.
 

Uses of WikiEngine in com.ecyrd.jspwiki.modules
 

Fields in com.ecyrd.jspwiki.modules declared as WikiEngine
protected  WikiEngine ModuleManager.m_engine
           
 

Constructors in com.ecyrd.jspwiki.modules with parameters of type WikiEngine
ModuleManager(WikiEngine engine)
          Constructs the ModuleManager.
 

Uses of WikiEngine in com.ecyrd.jspwiki.parser
 

Fields in com.ecyrd.jspwiki.parser declared as WikiEngine
protected  WikiEngine MarkupParser.m_engine
           
 

Methods in com.ecyrd.jspwiki.parser with parameters of type WikiEngine
static Collection JSPWikiMarkupParser.getImagePatterns(WikiEngine engine)
          Figure out which image suffixes should be inlined.
 

Uses of WikiEngine in com.ecyrd.jspwiki.plugin
 

Fields in com.ecyrd.jspwiki.plugin declared as WikiEngine
protected  WikiEngine AbstractReferralPlugin.m_engine
           
 

Methods in com.ecyrd.jspwiki.plugin with parameters of type WikiEngine
 String WeblogEntryPlugin.getNewEntryPage(WikiEngine engine, String blogName)
          Returns a new page name for entries.
 void InitializablePlugin.initialize(WikiEngine engine)
          Called whenever the plugin is being instantiated for the first time.
 void PageViewPlugin.initialize(WikiEngine engine)
          Initialize the PageViewPlugin and its singleton.
 void PageViewPlugin.PageViewManager.initialize(WikiEngine engine)
          Initialize the page view manager.
protected  void PluginManager.WikiPluginInfo.initializePlugin(WikiEngine engine)
          Initializes a plugin, if it has not yet been initialized.
 

Constructors in com.ecyrd.jspwiki.plugin with parameters of type WikiEngine
PluginManager(WikiEngine engine, Properties props)
          Create a new PluginManager.
 

Uses of WikiEngine in com.ecyrd.jspwiki.providers
 

Fields in com.ecyrd.jspwiki.providers declared as WikiEngine
protected  WikiEngine AbstractFileProvider.m_engine
           
 

Methods in com.ecyrd.jspwiki.providers with parameters of type WikiEngine
 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 RCSFileProvider.initialize(WikiEngine engine, Properties props)
          Initializes the page provider.
 void VersioningFileProvider.initialize(WikiEngine engine, Properties properties)
          Initializes the page provider.
 

Uses of WikiEngine in com.ecyrd.jspwiki.render
 

Methods in com.ecyrd.jspwiki.render with parameters of type WikiEngine
 void RenderingManager.initialize(WikiEngine engine, Properties properties)
          Initializes the RenderingManager.
 

Uses of WikiEngine in com.ecyrd.jspwiki.rss
 

Constructors in com.ecyrd.jspwiki.rss with parameters of type WikiEngine
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 com.ecyrd.jspwiki.search
 

Methods in com.ecyrd.jspwiki.search that return WikiEngine
protected  WikiEngine LuceneSearchProvider.getEngine()
          Returns the handling engine.
 

Methods in com.ecyrd.jspwiki.search with parameters of type WikiEngine
 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.
 void BasicSearchProvider.initialize(WikiEngine engine, Properties props)
          Initializes the page provider.
 void LuceneSearchProvider.initialize(WikiEngine engine, Properties props)
          Initializes the page provider.
 

Constructors in com.ecyrd.jspwiki.search with parameters of type WikiEngine
SearchManager(WikiEngine engine, Properties properties)
          Creates a new SearchManager.
 

Uses of WikiEngine in com.ecyrd.jspwiki.ui
 

Fields in com.ecyrd.jspwiki.ui declared as WikiEngine
protected  WikiEngine WikiServletFilter.m_engine
           
 

Constructors in com.ecyrd.jspwiki.ui with parameters of type WikiEngine
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, HttpServletRequest request)
          Constructs a new wrapped request.
 

Uses of WikiEngine in com.ecyrd.jspwiki.ui.admin
 

Fields in com.ecyrd.jspwiki.ui.admin declared as WikiEngine
protected  WikiEngine SimpleAdminBean.m_engine
          Provides access to a WikiEngine instance to which this AdminBean belongs to.
 

Methods in com.ecyrd.jspwiki.ui.admin with parameters of type WikiEngine
 void AdminBean.initialize(WikiEngine engine)
           
 void SimpleAdminBean.initialize(WikiEngine engine)
          Initialize the AdminBean by setting up a WikiEngine instance internally.
 

Constructors in com.ecyrd.jspwiki.ui.admin with parameters of type WikiEngine
AdminBeanManager(WikiEngine engine)
           
 

Uses of WikiEngine in com.ecyrd.jspwiki.ui.admin.beans
 

Methods in com.ecyrd.jspwiki.ui.admin.beans with parameters of type WikiEngine
 void PlainEditorAdminBean.initialize(WikiEngine engine)
           
 

Constructors in com.ecyrd.jspwiki.ui.admin.beans with parameters of type WikiEngine
CoreBean(WikiEngine engine)
           
PluginBean(WikiEngine engine)
           
SearchManagerBean(WikiEngine engine)
           
UserBean(WikiEngine engine)
           
 

Uses of WikiEngine in com.ecyrd.jspwiki.url
 

Fields in com.ecyrd.jspwiki.url declared as WikiEngine
protected  WikiEngine DefaultURLConstructor.m_engine
           
 

Methods in com.ecyrd.jspwiki.url with parameters of type WikiEngine
 void URLConstructor.initialize(WikiEngine engine, Properties properties)
          Initializes.
 void DefaultURLConstructor.initialize(WikiEngine engine, Properties properties)
          Initializes.
 void ShortURLConstructor.initialize(WikiEngine engine, Properties properties)
          Initializes.
 void ShortViewURLConstructor.initialize(WikiEngine engine, Properties properties)
          Initializes.
 

Uses of WikiEngine in com.ecyrd.jspwiki.util
 

Methods in com.ecyrd.jspwiki.util that return WikiEngine
 WikiEngine WikiBackgroundThread.getEngine()
          Returns the WikiEngine that created this background thread.
 

Methods in com.ecyrd.jspwiki.util with parameters of type WikiEngine
static WatchDog WatchDog.getCurrentWatchDog(WikiEngine engine)
          Returns the current watchdog for the current thread.
static void MailUtil.sendMessage(WikiEngine engine, String to, String subject, String content)
          Sends an e-mail to a specified receiver using a JavaMail Session supplied by a JNDI mail session factory (preferred) or a locally initialized session based on properties in jspwiki.properties.
 

Constructors in com.ecyrd.jspwiki.util with parameters of type WikiEngine
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.
 

Uses of WikiEngine in com.ecyrd.jspwiki.workflow
 

Methods in com.ecyrd.jspwiki.workflow that return WikiEngine
protected  WikiEngine WorkflowManager.getEngine()
          Protected helper method that returns the associated WikiEngine
 

Methods in com.ecyrd.jspwiki.workflow with parameters of type WikiEngine
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 com.ecyrd.jspwiki.xmlrpc
 

Fields in com.ecyrd.jspwiki.xmlrpc declared as WikiEngine
protected  WikiEngine AbstractRPCHandler.m_engine