Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 81589200CBC for ; Tue, 20 Jun 2017 21:32:20 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 7FB6D160BE1; Tue, 20 Jun 2017 19:32:20 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 545C2160BF2 for ; Tue, 20 Jun 2017 21:32:16 +0200 (CEST) Received: (qmail 22903 invoked by uid 500); 20 Jun 2017 19:32:15 -0000 Mailing-List: contact commits-help@jspwiki.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@jspwiki.apache.org Delivered-To: mailing list commits@jspwiki.apache.org Received: (qmail 22563 invoked by uid 99); 20 Jun 2017 19:32:14 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 20 Jun 2017 19:32:14 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id D03CDE112D; Tue, 20 Jun 2017 19:32:13 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: git-site-role@apache.org To: commits@jspwiki.apache.org Date: Tue, 20 Jun 2017 19:32:49 -0000 Message-Id: <7f400ad0e5364eaa90c99857eabf5ddd@git.apache.org> In-Reply-To: <0376810a7d4645cbb4310daffb0708ca@git.apache.org> References: <0376810a7d4645cbb4310daffb0708ca@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [38/51] [partial] jspwiki-site git commit: Automatic Site Publish by Buildbot archived-at: Tue, 20 Jun 2017 19:32:20 -0000 http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/570c2bf5/apidocs/2.10.1/org/apache/wiki/WikiEngine.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/WikiEngine.html b/apidocs/2.10.1/org/apache/wiki/WikiEngine.html deleted file mode 100755 index e3ed59f..0000000 --- a/apidocs/2.10.1/org/apache/wiki/WikiEngine.html +++ /dev/null @@ -1,3191 +0,0 @@ - - - - - - - -WikiEngine (Apache JSPWiki Main War 2.10.1 API) - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -org.apache.wiki -
-Class WikiEngine

-
-java.lang.Object
-  extended by org.apache.wiki.WikiEngine
-
-
-
-
public class WikiEngine
extends Object
- - - - - -
- -

-Provides Wiki services to the JSP page. - -

- This is the main interface through which everything should go. - -

- Using this class: Always get yourself an instance from JSP page - by using the WikiEngine.getInstance() method. Never create a new - WikiEngine() from scratch, unless you're writing tests. -

- There's basically only a single WikiEngine for each web application, and - you should always get it using the WikiEngine.getInstance() method. -

- -

-

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Field Summary
-static StringDEFAULT_INLINEPATTERN - -
-          The default inlining pattern.
-static StringPREFS_COOKIE_NAME - -
-          The name of the cookie that gets stored to the user browser.
-static StringPROP_ACL_MANAGER_IMPL - -
-          The name of the property containing the ACLManager implementing class.
-static StringPROP_ALLOW_CREATION_OF_EMPTY_PAGES - -
-          If this property is set to false, we don't allow the creation of empty pages
-static StringPROP_APPNAME - -
-          Property for application name
-static StringPROP_BASEURL - -
-          The name for the base URL to use in all references.
-static StringPROP_BEAUTIFYTITLE - -
-          Property name for the "spaces in titles" -hack.
-static StringPROP_ENCODING - -
-          Define the used encoding.
-static StringPROP_FRONTPAGE - -
-          Property name for the default front page.
-static StringPROP_INLINEIMAGEPTRN - -
-          This property defines the inline image pattern.
-static StringPROP_INTERWIKIREF - -
-          Property start for any interwiki reference.
-static StringPROP_MATCHPLURALS - -
-          Property name for the "match english plurals" -hack.
-static StringPROP_REFSTYLE - -
-          The name for the property which allows you to set the current reference - style.
-static StringPROP_RUNFILTERS - -
-          If this property is set to false, all filters are disabled when translating.
-static StringPROP_STOREUSERNAME - -
-          If true, then the user name will be stored with the page data.
-static StringPROP_TEMPLATEDIR - -
-          Property name for the template that is used.
-static StringPROP_URLCONSTRUCTOR - -
-          Property name for setting the url generator instance
-static StringPROP_WORKDIR - -
-          Property name for where the jspwiki work directory should be.
-  - - - - - - - - - - - - - - - -
-Constructor Summary
- WikiEngine(Properties properties) - -
-          Instantiate the WikiEngine using a given set of properties.
-protected WikiEngine(javax.servlet.ServletContext context, - String appid, - 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
- voidaddWikiEventListener(WikiEventListener listener) - -
-          Registers a WikiEventListener with this instance.
- StringbeautifyTitle(String title) - -
-          Beautifies the title of the page by appending spaces in suitable - places, if the user has so decreed in the properties when constructing - this WikiEngine.
- StringbeautifyTitleNoBreak(String title) - -
-          Beautifies the title of the page by appending non-breaking spaces - in suitable places.
- WikiContextcreateContext(javax.servlet.http.HttpServletRequest request, - String requestContext) - -
-          Shortcut to create a WikiContext from a supplied HTTP request, - using a default wiki context.
- StringdecodeName(String pagerequest) - -
-          Decodes a URL-encoded request back to regular life.
- voiddeletePage(String pageName) - -
-          Deletes a page or an attachment completely, including all versions.
- voiddeleteVersion(WikiPage page) - -
-          Deletes a specific version of a page or an attachment.
- StringencodeName(String pagename) - -
-          Turns a WikiName into something that can be - called through using an URL.
- CollectionfindPages(String query) - -
-          Parses an incoming search request, then - does a search.
-protected  voidfireEvent(int type) - -
-          Fires a WikiEngineEvent to all registered listeners.
-protected  voidfirePageEvent(int type, - String pageName) - -
-          Fires a WikiPageEvent to all registered listeners.
-protected  voidfirePageRenameEvent(String oldName, - String newName) - -
-          Fires a WikiPageRenameEvent to all registered listeners.
- AclManagergetAclManager() - -
-          Returns the AclManager employed by this WikiEngine.
- AdminBeanManagergetAdminBeanManager() - -
-          Returns the current AdminBeanManager.
- Collection<String>getAllInlinedImagePatterns() - -
-          Returns a collection of all image types that get inlined.
- Collection<String>getAllInterWikiLinks() - -
-          Returns a collection of all supported InterWiki links.
- StringgetApplicationName() - -
-          Returns the name of the application.
- AttachmentManagergetAttachmentManager() - -
-          Returns the current AttachmentManager, which is responsible for - storing and managing attachments.
- StringgetAttachmentURL(String attName) - -
-          Deprecated.  
- ObjectgetAttribute(String key) - -
-          Gets an attribute from the engine.
- AuthenticationManagergetAuthenticationManager() - -
-          Returns the currently used authentication manager.
- AuthorizationManagergetAuthorizationManager() - -
-          Returns the currently used authorization manager.
- StringgetBaseURL() - -
-          Returns the base URL, telling where this Wiki actually lives.
- CommandResolvergetCommandResolver() - -
-          Returns the CommandResolver for this wiki engine.
- StringgetContentEncoding() - -
-          Returns the IANA name of the character set encoding we're - supposed to be using right now.
- StringgetCurrentProvider() - -
-          Returns the provider name.
- StringgetCurrentProviderInfo() - -
-          Return information about current provider.
- WatchDoggetCurrentWatchDog() - -
-          Returns a WatchDog for current thread.
- StringgetDiff(WikiContext context, - int version1, - int version2) - -
-          Returns a diff of two versions of a page.
- DifferenceManagergetDifferenceManager() - -
-          Returns the DifferenceManager so that texts can be compared.
- EditorManagergetEditorManager() - -
-          Returns the current EditorManager instance.
- StringgetEditURL(String pageName) - -
-          Deprecated.  
- - - - - -
-<T extends FilterManager> -
-T
-		getFilterManager() - -
-          Returns the manager responsible for the filters.
- StringgetFinalPageName(String page) - -
-          Returns the correct page name, or null, if no such - page can be found.
- StringgetFrontPage() - -
-          Returns the default front page, if no page is used.
- StringgetGlobalRSSURL() - -
-          Returns the URL of the global RSS file.
- GroupManagergetGroupManager() - -
-          Returns the GroupManager employed by this WikiEngine.
- StringgetHTML(String page) - -
-          Returns the converted HTML of the page.
- StringgetHTML(String pagename, - int version) - -
-          Returns the converted HTML of the page's specific version.
- StringgetHTML(WikiContext context, - WikiPage page) - -
-          Returns the converted HTML of the page using a different - context than the default context.
-static WikiEnginegetInstance(javax.servlet.ServletConfig config) - -
-          Gets a WikiEngine related to this servlet.
-static WikiEnginegetInstance(javax.servlet.ServletConfig config, - Properties props) - -
-          Gets a WikiEngine related to the servlet.
-static WikiEnginegetInstance(javax.servlet.ServletContext context, - Properties props) - -
-          Gets a WikiEngine related to the servlet.
- InternationalizationManagergetInternationalizationManager() - -
-          Returns the current i18n manager.
- StringgetInterWikiURL(String wikiName) - -
-          Returns an URL to some other Wiki that we know.
- WikiPagegetPage(String pagereq) - -
-          Finds the corresponding WikiPage object based on the page name.
- WikiPagegetPage(String pagereq, - int version) - -
-          Finds the corresponding WikiPage object base on the page name and version.
- intgetPageCount() - -
-          Returns the number of pages in this Wiki
- PageManagergetPageManager() - -
-          Returns the current PageManager which is responsible for storing - and managing WikiPages.
- PageRenamergetPageRenamer() - -
-          Returns the PageRenamer employed by this WikiEngine.
- PageSortergetPageSorter() - -
-          Get this engine's page name comparator.
- - - - - -
-<T extends PluginManager> -
-T
-		getPluginManager() - -
-          Returns the current plugin manager.
- ProgressManagergetProgressManager() - -
-          Returns the progress manager we're using
- StringgetPureText(String page, - int version) - -
-          Returns the pure text of a page, no conversions.
- StringgetPureText(WikiPage page) - -
-          Returns the pure text of a page, no conversions.
- CollectiongetRecentChanges() - -
-          Returns a Collection of WikiPages, sorted in time - order of last change (i.e. first object is the most - recently changed).
- StringgetRedirectURL(WikiContext context) - -
-          Figure out to which page we are really going to.
- ReferenceManagergetReferenceManager() - -
-          Returns this object's ReferenceManager.
- RenderingManagergetRenderingManager() - -
-          Returns the current rendering manager for this wiki application.
- StringgetRootPath() - -
-          Returns the root path.
- RSSGeneratorgetRSSGenerator() - -
-          Returns the RSSGenerator.
- SearchManagergetSearchManager() - -
-          Returns the manager responsible for searching the Wiki.
- javax.servlet.ServletContextgetServletContext() - -
-          Returns the ServletContext that this particular WikiEngine was - initialized with.
- StringgetSpecialPageReference(String original) - -
-          If the page is a special page, then returns a direct URL - to that page.
- DategetStartTime() - -
-          Returns the moment when this engine was started.
- StringgetTemplateDir() - -
-          Returns the current template directory.
- TemplateManagergetTemplateManager() - -
-          Returns the current TemplateManager.
- StringgetText(String page) - -
-          Returns the un-HTMLized text of the latest version of a page.
- StringgetText(String page, - int version) - -
-          Returns the un-HTMLized text of the given version of a page.
- StringgetText(WikiContext context, - WikiPage page) - -
-          Returns the un-HTMLized text of the given version of a page in - the given context.
- StringgetURL(String context, - String pageName, - String params, - boolean absolute) - -
-          Returns an URL if a WikiContext is not available.
- URLConstructorgetURLConstructor() - -
-           
- UserManagergetUserManager() - -
-          Returns the UserManager employed by this WikiEngine.
- StringgetVariable(WikiContext context, - String name) - -
-          Shortcut to getVariableManager().getValue().
- VariableManagergetVariableManager() - -
-          Returns the current variable manager.
- ListgetVersionHistory(String page) - -
-          Returns a Collection of WikiPages containing the - version history of a page.
- StringgetViewURL(String pageName) - -
-           - Returns the basic absolute URL to a page, without any modifications.
- PropertiesgetWikiProperties() - -
-          Returns the set of properties that the WikiEngine was initialized - with.
- StringgetWorkDir() - -
-          Returns the JSPWiki working directory set with "jspwiki.workDir".
- WorkflowManagergetWorkflowManager() - -
-          Returns the WorkflowManager associated with this - WikiEngine.
- voidinitReferenceManager() - -
-          Initializes the reference manager.
- booleanpageExists(String page) - -
-          Returns true, if the requested page (or an alias) exists.
- booleanpageExists(String page, - int version) - -
-          Returns true, if the requested page (or an alias) exists with the - requested version.
- booleanpageExists(WikiPage page) - -
-          Returns true, if the requested page (or an alias) exists, with the - specified version in the WikiPage.
- ObjectremoveAttribute(String key) - -
-          Removes an attribute.
- voidremoveWikiEventListener(WikiEventListener listener) - -
-          Un-registers a WikiEventListener with this instance.
- StringrenamePage(WikiContext context, - String renameFrom, - String renameTo, - boolean changeReferrers) - -
-          Renames, or moves, a wiki page.
- StringsafeGetParameter(javax.servlet.ServletRequest request, - String name) - -
-          Deprecated. JSPWiki now requires servlet API 2.3, which has a better - way of dealing with this stuff. This will be removed in - the near future.
- StringsafeGetQueryString(javax.servlet.http.HttpServletRequest request) - -
-          Returns the query string (the portion after the question mark).
- voidsaveText(WikiContext context, - String text) - -
-          Writes the WikiText of a page into the - page repository.
- Collection<String>scanWikiLinks(WikiPage page, - String pagedata) - -
-          Reads a WikiPageful of data from a String and returns all links - internal to this Wiki in a Collection.
- voidsetAttribute(String key, - Object value) - -
-          Adds an attribute to the engine for the duration of this engine.
-protected  voidshutdown() - -
-          Protected method that signals that the WikiEngine will be - shut down by the servlet container.
- StringtextToHTML(WikiContext context, - String pagedata) - -
-          Converts raw page data to HTML.
- StringtextToHTML(WikiContext context, - String pagedata, - StringTransmutator localLinkHook, - StringTransmutator extLinkHook) - -
-          Just convert WikiText to HTML.
- StringtextToHTML(WikiContext context, - String pagedata, - StringTransmutator localLinkHook, - StringTransmutator extLinkHook, - StringTransmutator attLinkHook) - -
-          Just convert WikiText to HTML.
- voidupdateReferences(WikiPage page) - -
-          Updates all references for the given page.
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Field Detail
- -

-DEFAULT_INLINEPATTERN

-
-public static final String DEFAULT_INLINEPATTERN
-
-
The default inlining pattern. Currently "*.png" -

-

-
See Also:
Constant Field Values
-
-
- -

-PROP_APPNAME

-
-public static final String PROP_APPNAME
-
-
Property for application name -

-

-
See Also:
Constant Field Values
-
-
- -

-PROP_INLINEIMAGEPTRN

-
-public static final String PROP_INLINEIMAGEPTRN
-
-
This property defines the inline image pattern. It's current value is "jspwiki.translatorReader.inlinePattern" -

-

-
See Also:
Constant Field Values
-
-
- -

-PROP_INTERWIKIREF

-
-public static final String PROP_INTERWIKIREF
-
-
Property start for any interwiki reference. -

-

-
See Also:
Constant Field Values
-
-
- -

-PROP_STOREUSERNAME

-
-public static final String PROP_STOREUSERNAME
-
-
If true, then the user name will be stored with the page data. -

-

-
See Also:
Constant Field Values
-
-
- -

-PROP_ENCODING

-
-public static final String PROP_ENCODING
-
-
Define the used encoding. Currently supported are ISO-8859-1 and UTF-8 -

-

-
See Also:
Constant Field Values
-
-
- -

-PROP_BASEURL

-
-public static final String PROP_BASEURL
-
-
The name for the base URL to use in all references. -

-

-
See Also:
Constant Field Values
-
-
- -

-PROP_REFSTYLE

-
-public static final String PROP_REFSTYLE
-
-
The name for the property which allows you to set the current reference - style. The value is "jspwiki.referenceStyle". -

-

-
See Also:
Constant Field Values
-
-
- -

-PROP_BEAUTIFYTITLE

-
-public static final String PROP_BEAUTIFYTITLE
-
-
Property name for the "spaces in titles" -hack. -

-

-
See Also:
Constant Field Values
-
-
- -

-PROP_WORKDIR

-
-public static final String PROP_WORKDIR
-
-
Property name for where the jspwiki work directory should be. - If not specified, reverts to ${java.tmpdir}. -

-

-
http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/570c2bf5/apidocs/2.10.1/org/apache/wiki/WikiEngine.png ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/WikiEngine.png b/apidocs/2.10.1/org/apache/wiki/WikiEngine.png deleted file mode 100755 index a66e11b..0000000 Binary files a/apidocs/2.10.1/org/apache/wiki/WikiEngine.png and /dev/null differ