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 E4A3F200C51 for ; Sat, 25 Mar 2017 16:53:12 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id E363A160B7B; Sat, 25 Mar 2017 15:53:12 +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 29D63160BB9 for ; Sat, 25 Mar 2017 16:53:08 +0100 (CET) Received: (qmail 50337 invoked by uid 500); 25 Mar 2017 15:53:07 -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 49701 invoked by uid 99); 25 Mar 2017 15:53:06 -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; Sat, 25 Mar 2017 15:53:06 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 816FDDFE7B; Sat, 25 Mar 2017 15:53:06 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: juanpablo@apache.org To: commits@jspwiki.apache.org Date: Sat, 25 Mar 2017 15:53:41 -0000 Message-Id: <6af46d4b08a04bf7a4149d08a0025ecc@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [37/51] [abbrv] [partial] jspwiki-site git commit: first take at generating content archived-at: Sat, 25 Mar 2017 15:53:13 -0000 http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/7f9ce779/content/apidocs/2.10.1/org/apache/wiki/WikiPage.html ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/WikiPage.html b/content/apidocs/2.10.1/org/apache/wiki/WikiPage.html new file mode 100755 index 0000000..f4a44da --- /dev/null +++ b/content/apidocs/2.10.1/org/apache/wiki/WikiPage.html @@ -0,0 +1,952 @@ + + + + + + + +WikiPage (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 WikiPage

+
+java.lang.Object
+  extended by org.apache.wiki.WikiPage
+
+
+
All Implemented Interfaces:
Cloneable, Comparable
+
+
+
Direct Known Subclasses:
Attachment
+
+
+
+
public class WikiPage
extends Object
implements Cloneable, Comparable
+ + + + + + + +
+ +

+Simple wrapper class for the Wiki page attributes. The Wiki page + content is moved around in Strings, though. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringALIAS + +
+          A special variable name for storing a page alias.
+static StringCHANGENOTE + +
+          A special variable name for storing a changenote.
+static StringDESCRIPTION + +
+          "Summary" is a short summary of the page.
+static StringREDIRECT + +
+          A special variable name for storing a redirect note
+  + + + + + + + + + + +
+Constructor Summary
WikiPage(WikiEngine engine, + String name) + +
+          Create a new WikiPage using a given engine and name.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Objectclone() + +
+          Creates a deep clone of a WikiPage.
+ intcompareTo(Object page) + +
+          Compares a page with another using the defined PageNameComparator.
+ AclgetAcl() + +
+          Returns the Acl for this page.
+ ObjectgetAttribute(String key) + +
+          A WikiPage may have a number of attributes, which might or might not be + available.
+ MapgetAttributes() + +
+          Returns the full attributes Map, in case external code needs + to iterate through the attributes.
+ StringgetAuthor() + +
+          Returns author name, or null, if no author has been defined.
+ DategetLastModified() + +
+          Returns the date when this page was last modified.
+ StringgetName() + +
+          Returns the name of the page.
+ longgetSize() + +
+          Returns the size of the page.
+ intgetVersion() + +
+          Returns the version that this WikiPage instance represents.
+ StringgetWiki() + +
+          Returns the wiki nanme for this page
+ inthashCode() + +
+          
+ booleanhasMetadata() + +
+          Returns true if the page has valid metadata; that is, it has been parsed.
+ voidinvalidateMetadata() + +
+          This method will remove all metadata from the page.
+ ObjectremoveAttribute(String key) + +
+          Removes an attribute from the page, if it exists.
+ voidsetAcl(Acl acl) + +
+          Sets the Acl for this page.
+ voidsetAttribute(String key, + Object attribute) + +
+          Sets an metadata attribute.
+ voidsetAuthor(String author) + +
+          Sets the author of the page.
+ voidsetHasMetadata() + +
+          Sets the metadata flag to true.
+ voidsetLastModified(Date date) + +
+          Sets the last modification date.
+ voidsetSize(long size) + +
+          Sets the size.
+ voidsetVersion(int version) + +
+          Sets the page version.
+ StringtoString() + +
+          Returns a debug-suitable version of the page.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+DESCRIPTION

+
+public static final String DESCRIPTION
+
+
"Summary" is a short summary of the page. It is a String. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ALIAS

+
+public static final String ALIAS
+
+
A special variable name for storing a page alias. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REDIRECT

+
+public static final String REDIRECT
+
+
A special variable name for storing a redirect note +

+

+
See Also:
Constant Field Values
+
+
+ +

+CHANGENOTE

+
+public static final String CHANGENOTE
+
+
A special variable name for storing a changenote. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+WikiPage

+
+public WikiPage(WikiEngine engine,
+                String name)
+
+
Create a new WikiPage using a given engine and name. +

+

+
Parameters:
engine - The WikiEngine that owns this page.
name - The name of the page.
+
+ + + + + + + + +
+Method Detail
+ +

+getName

+
+public String getName()
+
+
Returns the name of the page. +

+

+
+
+
+ +
Returns:
The page name.
+
+
+
+ +

+getAttribute

+
+public Object getAttribute(String key)
+
+
A WikiPage may have a number of attributes, which might or might not be + available. Typically attributes are things that do not need to be stored + with the wiki page to the page repository, but are generated + on-the-fly. A provider is not required to save them, but they + can do that if they really want. +

+

+
+
+
+
Parameters:
key - The key using which the attribute is fetched +
Returns:
The attribute. If the attribute has not been set, returns null.
+
+
+
+ +

+setAttribute

+
+public void setAttribute(String key,
+                         Object attribute)
+
+
Sets an metadata attribute. +

+

+
+
+
+
Parameters:
key - The key for the attribute used to fetch the attribute later on.
attribute - The attribute value
See Also:
getAttribute(String)
+
+
+
+ +

+getAttributes

+
+public Map getAttributes()
+
+
Returns the full attributes Map, in case external code needs + to iterate through the attributes. +

+

+
+
+
+ +
Returns:
The attribute Map. Please note that this is a direct + reference, not a copy.
+
+
+
+ +

+removeAttribute

+
+public Object removeAttribute(String key)
+
+
Removes an attribute from the page, if it exists. +

+

+
+
+
+
Parameters:
key - The key for the attribute +
Returns:
If the attribute existed, returns the object.
Since:
+
2.1.111
+
+
+
+
+ +

+getLastModified

+
+public Date getLastModified()
+
+
Returns the date when this page was last modified. +

+

+
+
+
+ +
Returns:
The last modification date
+
+
+
+ +

+setLastModified

+
+public void setLastModified(Date date)
+
+
Sets the last modification date. In general, this is only + changed by the provider. +

+

+
+
+
+
Parameters:
date - The date
+
+
+
+ +

+setVersion

+
+public void setVersion(int version)
+
+
Sets the page version. In general, this is only changed + by the provider. +

+

+
+
+
+
Parameters:
version - The version number
+
+
+
+ +

+getVersion

+
+public int getVersion()
+
+
Returns the version that this WikiPage instance represents. +

+

+
+
+
+ +
Returns:
the version number of this page.
+
+
+
+ +

+getSize

+
+public long getSize()
+
+
Returns the size of the page. +

+

+
+
+
+ +
Returns:
the size of the page.
Since:
+
2.1.109
+
+
+
+
+ +

+setSize

+
+public void setSize(long size)
+
+
Sets the size. Typically called by the provider only. +

+

+
+
+
+
Parameters:
size - The size of the page.
Since:
+
2.1.109
+
+
+
+
+ +

+getAcl

+
+public Acl getAcl()
+
+
Returns the Acl for this page. May return null, + in case there is no Acl defined, or it has not + yet been set by setAcl(Acl). +

+

+
+
+
+ +
Returns:
The access control list. May return null, if there is + no acl.
+
+
+
+ +

+setAcl

+
+public void setAcl(Acl acl)
+
+
Sets the Acl for this page. Note that method does not + persist the Acl itself to back-end storage or in page markup; + it merely sets the internal field that stores the Acl. To + persist the Acl, callers should invoke + AclManager.setPermissions(WikiPage, Acl). +

+

+
+
+
+
Parameters:
acl - The Acl to set
+
+
+
+ +

+setAuthor

+
+public void setAuthor(String author)
+
+
Sets the author of the page. Typically called only by the provider. +

+

+
+
+
+
Parameters:
author - The author name.
+
+
+
+ +

+getAuthor

+
+public String getAuthor()
+
+
Returns author name, or null, if no author has been defined. +

+

+
+
+
+ +
Returns:
Author name, or possibly null.
+
+
+
+ +

+getWiki

+
+public String getWiki()
+
+
Returns the wiki nanme for this page +

+

+
+
+
+ +
Returns:
The name of the wiki.
+
+
+
+ +

+invalidateMetadata

+
+public void invalidateMetadata()
+
+
This method will remove all metadata from the page. +

+

+
+
+
+
+
+
+
+ +

+hasMetadata

+
+public boolean hasMetadata()
+
+
Returns true if the page has valid metadata; that is, it has been parsed. + Note that this method is a kludge to support our pre-3.0 metadata system, and as such + will go away with the new API. +

+

+
+
+
+ +
Returns:
true, if the page has metadata.
+
+
+
+ +

+setHasMetadata

+
+public void setHasMetadata()
+
+
Sets the metadata flag to true. Never call. +

+

+
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
Returns a debug-suitable version of the page. +

+

+
Overrides:
toString in class Object
+
+
+ +
Returns:
A debug string.
+
+
+
+ +

+clone

+
+public Object clone()
+
+
Creates a deep clone of a WikiPage. Strings are not cloned, since + they're immutable. Attributes are not cloned, only the internal + HashMap (so if you modify the contents of a value of an attribute, + these will reflect back to everyone). +

+

+
Overrides:
clone in class Object
+
+
+ +
Returns:
A deep clone of the WikiPage
+
+
+
+ +

+compareTo

+
+public int compareTo(Object page)
+
+
Compares a page with another using the defined PageNameComparator. See org.apache.wiki.util.PageSorter. +

+

+
Specified by:
compareTo in interface Comparable
+
+
+
Parameters:
page - The object to compare against +
Returns:
-1, 0 or 1
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+

+

+
Overrides:
hashCode in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/7f9ce779/content/apidocs/2.10.1/org/apache/wiki/WikiPage.png ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/WikiPage.png b/content/apidocs/2.10.1/org/apache/wiki/WikiPage.png new file mode 100755 index 0000000..0f65e2b Binary files /dev/null and b/content/apidocs/2.10.1/org/apache/wiki/WikiPage.png differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/7f9ce779/content/apidocs/2.10.1/org/apache/wiki/WikiProvider.html ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/WikiProvider.html b/content/apidocs/2.10.1/org/apache/wiki/WikiProvider.html new file mode 100755 index 0000000..3b338e2 --- /dev/null +++ b/content/apidocs/2.10.1/org/apache/wiki/WikiProvider.html @@ -0,0 +1,302 @@ + + + + + + + +WikiProvider (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 +
+Interface WikiProvider

+
+
All Known Subinterfaces:
DiffProvider, SearchProvider, WikiAttachmentProvider, WikiPageProvider
+
+
+
All Known Implementing Classes:
AbstractFileProvider, BasicAttachmentProvider, BasicSearchProvider, CachingAttachmentProvider, CachingProvider, ContextualDiffProvider, DiffP rovider.NullDiffProvider, ExternalDiffProvider, FileSystemProvider, LuceneSearchProvider, TraditionalDiffProvider, VersioningFileProvider
+
+
+
+
public interface WikiProvider
+ + + + + + + + +
+ +

+A generic Wiki provider for all sorts of things that the Wiki can + store. +

+ +

+

+
Since:
+
2.0
+
+
+ +

+ + + + + + + + + + + +
+Field Summary
+static intLATEST_VERSION + +
+          Passing this to any method should get the latest version
+  + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetProviderInfo() + +
+          Return a valid HTML string for information.
+ voidinitialize(WikiEngine engine, + Properties properties) + +
+          Initializes the page provider.
+  +

+ + + + + + + + +
+Field Detail
+ +

+LATEST_VERSION

+
+static final int LATEST_VERSION
+
+
Passing this to any method should get the latest version +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+initialize

+
+void initialize(WikiEngine engine,
+                Properties properties)
+                throws NoRequiredPropertyException,
+                       IOException
+
+
Initializes the page provider. +

+

+
Parameters:
engine - WikiEngine to own this provider
properties - A set of properties used to initialize this provider +
Throws: +
NoRequiredPropertyException - If the provider needs a property which is not found in the property set +
IOException - If there is an IO problem
+
+
+
+ +

+getProviderInfo

+
+String getProviderInfo()
+
+
Return a valid HTML string for information. May + be anything. +

+

+ +
Returns:
A string describing the provider.
Since:
+
1.6.4
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/7f9ce779/content/apidocs/2.10.1/org/apache/wiki/WikiProvider.png ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/WikiProvider.png b/content/apidocs/2.10.1/org/apache/wiki/WikiProvider.png new file mode 100755 index 0000000..a962d96 Binary files /dev/null and b/content/apidocs/2.10.1/org/apache/wiki/WikiProvider.png differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/7f9ce779/content/apidocs/2.10.1/org/apache/wiki/WikiServlet.html ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/WikiServlet.html b/content/apidocs/2.10.1/org/apache/wiki/WikiServlet.html new file mode 100755 index 0000000..d487175 --- /dev/null +++ b/content/apidocs/2.10.1/org/apache/wiki/WikiServlet.html @@ -0,0 +1,390 @@ + + + + + + + +WikiServlet (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 WikiServlet

+
+java.lang.Object
+  extended by javax.servlet.GenericServlet
+      extended by javax.servlet.http.HttpServlet
+          extended by org.apache.wiki.WikiServlet
+
+
+
All Implemented Interfaces:
Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
+
+
+
+
public class WikiServlet
extends javax.servlet.http.HttpServlet
+ + + + + +
+ +

+This provides a master servlet for dealing with short urls. It mostly does + redirects to the proper JSP pages. It also intercepts the servlet + shutdown events and uses it to signal wiki shutdown. +

+ +

+

+
Since:
+
2.2
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
WikiServlet() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddestroy() + +
+          Destroys the WikiServlet; called by the servlet container + when shutting down the webapp.
+ voiddoGet(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res) + +
+          
+ voiddoPost(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res) + +
+          
+ voidinit(javax.servlet.ServletConfig config) + +
+          
+  + + + + + + + +
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service
+  + + + + + + + +
Methods inherited from class javax.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+WikiServlet

+
+public WikiServlet()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(javax.servlet.ServletConfig config)
+          throws javax.servlet.ServletException
+
+
+

+

+
Specified by:
init in interface javax.servlet.Servlet
Overrides:
init in class javax.servlet.GenericServlet
+
+
+ +
Throws: +
javax.servlet.ServletException
+
+
+
+ +

+destroy

+
+public void destroy()
+
+
Destroys the WikiServlet; called by the servlet container + when shutting down the webapp. This method calls the + protected method WikiEngine.shutdown(), which + sends WikiEngineEvent.SHUTDOWN + events to registered listeners. +

+

+
Specified by:
destroy in interface javax.servlet.Servlet
Overrides:
destroy in class javax.servlet.GenericServlet
+
+
+
See Also:
GenericServlet.destroy()
+
+
+
+ +

+doPost

+
+public void doPost(javax.servlet.http.HttpServletRequest req,
+                   javax.servlet.http.HttpServletResponse res)
+            throws IOException,
+                   javax.servlet.ServletException
+
+
+

+

+
Overrides:
doPost in class javax.servlet.http.HttpServlet
+
+
+ +
Throws: +
IOException +
javax.servlet.ServletException
+
+
+
+ +

+doGet

+
+public void doGet(javax.servlet.http.HttpServletRequest req,
+                  javax.servlet.http.HttpServletResponse res)
+           throws IOException,
+                  javax.servlet.ServletException
+
+
+

+

+
Overrides:
doGet in class javax.servlet.http.HttpServlet
+
+
+ +
Throws: +
IOException +
javax.servlet.ServletException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/7f9ce779/content/apidocs/2.10.1/org/apache/wiki/WikiServlet.png ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/WikiServlet.png b/content/apidocs/2.10.1/org/apache/wiki/WikiServlet.png new file mode 100755 index 0000000..10ac477 Binary files /dev/null and b/content/apidocs/2.10.1/org/apache/wiki/WikiServlet.png differ