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 DC433200CBC for ; Tue, 20 Jun 2017 23:51:15 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id DA70C160BF2; Tue, 20 Jun 2017 21:51:15 +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 B4C06160C06 for ; Tue, 20 Jun 2017 23:51:11 +0200 (CEST) Received: (qmail 74658 invoked by uid 500); 20 Jun 2017 21:51:10 -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 74521 invoked by uid 99); 20 Jun 2017 21:51:10 -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 21:51:10 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id C7479E9638; Tue, 20 Jun 2017 21:51:09 +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: Tue, 20 Jun 2017 21:51:29 -0000 Message-Id: <974d6ae8238b4a00b76dc6a591f2db6b@git.apache.org> In-Reply-To: <9f173fc9a5914f9595112465b4516697@git.apache.org> References: <9f173fc9a5914f9595112465b4516697@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [21/51] [abbrv] [partial] jspwiki-site git commit: Site + Apidocs Maven Publish archived-at: Tue, 20 Jun 2017 21:51:16 -0000 http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/b37788df/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachment.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachment.html b/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachment.html new file mode 100755 index 0000000..afa0f11 --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachment.html @@ -0,0 +1,364 @@ + + + + + + + +DynamicAttachment (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.attachment +
+Class DynamicAttachment

+
+java.lang.Object
+  extended by org.apache.wiki.WikiPage
+      extended by org.apache.wiki.attachment.Attachment
+          extended by org.apache.wiki.attachment.DynamicAttachment
+
+
+
All Implemented Interfaces:
Cloneable, Comparable
+
+
+
+
public class DynamicAttachment
extends Attachment
+ + + + + +
+ +

+A DynamicAttachment is an attachment which does not really exist, but is + created dynamically by a JSPWiki component. +

+ Note that a DynamicAttachment might not be available before it is actually + created by a component (e.g. plugin), and therefore trying to access it + before that component has been invoked, might result in a surprising 404. +

+ DynamicAttachments are not listed among regular attachments in the current + version. +

+ Usage: + + 

+
+  class MyDynamicComponent implements DynamicAttachmentProvider
+  {
+  ...
+
+     DynamicAttachment destatt = mgr.getDynamicAttachment( destattname );
+
+     if( destatt == null )
+     {
+         destatt = new DynamicAttachment( context.getEngine(),
+                                          context.getPage().getName(),
+                                          destfilename,
+                                          this );
+         destatt.setCacheable( false );
+     }
+
+     // This is used to check whether the attachment is modified or not
+     // so don't forget to update this if your attachment source changes!
+     // Else JSPWiki will be serving 304s to anyone who asks...
+
+     destatt.setLastModified( context.getPage().getLastModified() );
+     mgr.storeDynamicAttachment( context,  destatt );
+  ...
+
+      public InputStream getAttachmentData( WikiContext context, Attachment att )
+          throws IOException
+      {
+          byte[] bytes = "This is a test".getBytes();
+
+          return new ByteArrayInputStream( bytes );
+      }
+
+

+ +

+

+
Since:
+
2.5.34
+
+
+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class org.apache.wiki.WikiPage
ALIAS, CHANGENOTE, DESCRIPTION, REDIRECT
+  + + + + + + + + + + +
+Constructor Summary
DynamicAttachment(WikiEngine engine, + String parentPage, + String fileName, + DynamicAttachmentProvider provider) + +
+          Creates a DynamicAttachment.
+  + + + + + + + + + + + +
+Method Summary
+ DynamicAttachmentProvidergetProvider() + +
+          Returns the provider which is used to generate this attachment.
+  + + + + + + + +
Methods inherited from class org.apache.wiki.attachment.Attachment
getFileName, getParentName, isCacheable, setCacheable, setFileName, toString
+  + + + + + + + +
Methods inherited from class org.apache.wiki.WikiPage
clone, compareTo, getAcl, getAttribute, getAttributes, getAuthor, getLastModified, getName, getSize, getVersion, getWiki, hashCode, hasMetadata, invalidateMetadata, removeAttribute, setAcl, setAttribute, setAuthor, setHasMetadata, setLastModified, setSize, setVersion
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

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

+DynamicAttachment

+
+public DynamicAttachment(WikiEngine engine,
+                         String parentPage,
+                         String fileName,
+                         DynamicAttachmentProvider provider)
+
+
Creates a DynamicAttachment. +

+

+
Parameters:
engine - The engine which owns this attachment
parentPage - The page which owns this attachment
fileName - The filename of the attachment
provider - The provider which will be used to generate the attachment.
+
+ + + + + + + + +
+Method Detail
+ +

+getProvider

+
+public DynamicAttachmentProvider getProvider()
+
+
Returns the provider which is used to generate this attachment. +

+

+ +
Returns:
A Provider component for this attachment.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/b37788df/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachment.png ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachment.png b/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachment.png new file mode 100755 index 0000000..463a4d6 Binary files /dev/null and b/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachment.png differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/b37788df/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachmentProvider.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachmentProvider.html b/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachmentProvider.html new file mode 100755 index 0000000..2f27f99 --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachmentProvider.html @@ -0,0 +1,235 @@ + + + + + + + +DynamicAttachmentProvider (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.attachment +
+Interface DynamicAttachmentProvider

+
+
+
public interface DynamicAttachmentProvider
+ + + + +
+ +

+Provides the data for an attachment. Please note that there will + be a strong reference retained for the provider for each Attachment + it provides, so do try to keep the object light. Also, reuse objects + if possible. +

+ The Provider needs to be thread-safe. +

+ +

+

+
Since:
+
2.5.34
+
+
+ +

+ + + + + + + + + + + + +
+Method Summary
+ InputStreamgetAttachmentData(WikiContext context, + Attachment att) + +
+          Returns a stream of data for this attachment.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getAttachmentData

+
+InputStream getAttachmentData(WikiContext context,
+                              Attachment att)
+                              throws ProviderException,
+                                     IOException
+
+
Returns a stream of data for this attachment. The stream will be + closed by AttachmentServlet. +

+

+
Parameters:
context - A Wiki Context
att - The Attachment for which the data should be received. +
Returns:
InputStream for the data. +
Throws: +
ProviderException - If something goes wrong internally +
IOException - If something goes wrong when reading the data
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/b37788df/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachmentProvider.png ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachmentProvider.png b/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachmentProvider.png new file mode 100755 index 0000000..c223ea3 Binary files /dev/null and b/apidocs/2.10.1/org/apache/wiki/attachment/DynamicAttachmentProvider.png differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/b37788df/apidocs/2.10.1/org/apache/wiki/attachment/class-use/Attachment.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/attachment/class-use/Attachment.html b/apidocs/2.10.1/org/apache/wiki/attachment/class-use/Attachment.html new file mode 100755 index 0000000..446b6ac --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/attachment/class-use/Attachment.html @@ -0,0 +1,507 @@ + + + + + + + +Uses of Class org.apache.wiki.attachment.Attachment (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
org.apache.wiki.attachment.Attachment

+
+ + + + + + + + + + + + + + + + + +
+Packages that use Attachment
org.apache.wiki.attachmentAttachment management, uploading and downloading. 
org.apache.wiki.providersProvides storage for JSPWiki. 
org.apache.wiki.searchProvides the JSPWiki search functionality. 
+  +

+ + + + + +
+Uses of Attachment in org.apache.wiki.attachment
+  +

+ + + + + + + + + +
Subclasses of Attachment in org.apache.wiki.attachment
+ classDynamicAttachment + +
+          A DynamicAttachment is an attachment which does not really exist, but is + created dynamically by a JSPWiki component.
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in org.apache.wiki.attachment that return Attachment
+ AttachmentAttachmentManager.getAttachmentInfo(String name) + +
+          Gets info on a particular attachment, latest version.
+ AttachmentAttachmentManager.getAttachmentInfo(String name, + int version) + +
+          Gets info on a particular attachment with the given version.
+ AttachmentAttachmentManager.getAttachmentInfo(WikiContext context, + String attachmentname) + +
+          Figures out the full attachment name from the context and + attachment name.
+ AttachmentAttachmentManager.getAttachmentInfo(WikiContext context, + String attachmentname, + int version) + +
+          Figures out the full attachment name from the context and + attachment name.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.apache.wiki.attachment with parameters of type Attachment
+ voidAttachmentManager.deleteAttachment(Attachment att) + +
+          Deletes all versions of the given attachment.
+ voidAttachmentManager.deleteVersion(Attachment att) + +
+          Deletes the given attachment version.
+ InputStreamDynamicAttachmentProvider.getAttachmentData(WikiContext context, + Attachment att) + +
+          Returns a stream of data for this attachment.
+ InputStreamAttachmentManager.getAttachmentStream(Attachment att) + +
+          Finds a (real) attachment from the repository as a stream.
+ InputStreamAttachmentManager.getAttachmentStream(WikiContext ctx, + Attachment att) + +
+          Returns an attachment stream using the particular WikiContext.
+ voidAttachmentManager.storeAttachment(Attachment att, + File source) + +
+          Stores an attachment that lives in the given file.
+ voidAttachmentManager.storeAttachment(Attachment att, + InputStream in) + +
+          Stores an attachment directly from a stream.
+  +

+ + + + + +
+Uses of Attachment in org.apache.wiki.providers
+  +

+ + + + + + + + + + + + + + + + + +
Methods in org.apache.wiki.providers that return Attachment
+ AttachmentWikiAttachmentProvider.getAttachmentInfo(WikiPage page, + String name, + int version) + +
+          Returns info about an attachment.
+ AttachmentCachingAttachmentProvider.getAttachmentInfo(WikiPage page, + String name, + int version) + +
+          Returns info about an attachment.
+ AttachmentBasicAttachmentProvider.getAttachmentInfo(WikiPage page, + String name, + int version) + +
+          Returns info about an attachment.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.apache.wiki.providers with parameters of type Attachment
+ voidWikiAttachmentProvider.deleteAttachment(Attachment att) + +
+          Removes an entire page from the repository.
+ voidCachingAttachmentProvider.deleteAttachment(Attachment att) + +
+          Removes an entire page from the repository.
+ voidBasicAttachmentProvider.deleteAttachment(Attachment att) + +
+          Removes an entire page from the repository.
+ voidWikiAttachmentProvider.deleteVersion(Attachment att) + +
+          Removes a specific version from the repository.
+ voidCachingAttachmentProvider.deleteVersion(Attachment att) + +
+          Removes a specific version from the repository.
+ voidBasicAttachmentProvider.deleteVersion(Attachment att) + +
+          Removes a specific version from the repository.
+ InputStreamWikiAttachmentProvider.getAttachmentData(Attachment att) + +
+          Get attachment data.
+ InputStreamCachingAttachmentProvider.getAttachmentData(Attachment att) + +
+          Get attachment data.
+ InputStreamBasicAttachmentProvider.getAttachmentData(Attachment att) + +
+          Get attachment data.
+ ListWikiAttachmentProvider.getVersionHistory(Attachment att) + +
+          Returns version history.
+ ListCachingAttachmentProvider.getVersionHistory(Attachment att) + +
+          Returns version history.
+ ListBasicAttachmentProvider.getVersionHistory(Attachment att) + +
+          Returns version history.
+ voidWikiAttachmentProvider.putAttachmentData(Attachment att, + InputStream data) + +
+          Put new attachment data.
+ voidCachingAttachmentProvider.putAttachmentData(Attachment att, + InputStream data) + +
+          Put new attachment data.
+ voidBasicAttachmentProvider.putAttachmentData(Attachment att, + InputStream data) + +
+          Put new attachment data.
+  +

+ + + + + +
+Uses of Attachment in org.apache.wiki.search
+  +

+ + + + + + + + + +
Methods in org.apache.wiki.search with parameters of type Attachment
+protected  StringLuceneSearchProvider.getAttachmentContent(Attachment att) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/b37788df/apidocs/2.10.1/org/apache/wiki/attachment/class-use/AttachmentManager.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/attachment/class-use/AttachmentManager.html b/apidocs/2.10.1/org/apache/wiki/attachment/class-use/AttachmentManager.html new file mode 100755 index 0000000..28b163b --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/attachment/class-use/AttachmentManager.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class org.apache.wiki.attachment.AttachmentManager (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
org.apache.wiki.attachment.AttachmentManager

+
+ + + + + + + + + +
+Packages that use AttachmentManager
org.apache.wikiThe chief package of JSPWiki. 
+  +

+ + + + + +
+Uses of AttachmentManager in org.apache.wiki
+  +

+ + + + + + + + + +
Methods in org.apache.wiki that return AttachmentManager
+ AttachmentManagerWikiEngine.getAttachmentManager() + +
+          Returns the current AttachmentManager, which is responsible for + storing and managing attachments.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/b37788df/apidocs/2.10.1/org/apache/wiki/attachment/class-use/AttachmentServlet.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/attachment/class-use/AttachmentServlet.html b/apidocs/2.10.1/org/apache/wiki/attachment/class-use/AttachmentServlet.html new file mode 100755 index 0000000..7c6767e --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/attachment/class-use/AttachmentServlet.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.wiki.attachment.AttachmentServlet (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
org.apache.wiki.attachment.AttachmentServlet

+
+No usage of org.apache.wiki.attachment.AttachmentServlet +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + +