de.tuberlin.cs.flp.jspwiki.plugin
See also configuration parameters: ...enableDelete ...enableZipAttachments
|
|||
public static
String
|
ATTRIBUTE_EXPORT_CONTENTDISPOSITION Constant ATTRIBUTE_EXPORT_CONTENTDISPOSITION.
|
||
public static
String
|
ATTRIBUTE_EXPORT_CONTENTTYPE Constant ATTRIBUTE_EXPORT_CONTENTTYPE.
|
||
public static
String
|
ATTRIBUTE_EXPORT_RESULT Constant ATTRIBUTE_EXPORT_RESULT.
|
||
public static
int
|
BOTH Constant BOTH.
|
||
public static
String
|
CHARACTER_ENCODING Character encoding used by uploaded files and used for generating download data.
|
||
public static
String
|
DEFAULT_TEMP_DIR Temporary directory used if not otherwise configured via
parameter "jspwiki.plugin_name.uploadTempDir" in WEB-INF/jspwiki.properties.
|
||
public static
int
|
EXPORT Constant EXPORT.
|
||
public static
int
|
IMPORT Constant IMPORT.
|
||
public static
int
|
MODE_BOTH Constant MODE_BOTH.
|
||
public static
int
|
MODE_INSERT Constant MODE_INSERT.
|
||
public static
int
|
MODE_NONE Constant MODE_NONE.
|
||
public static
int
|
MODE_SINGLE Constant MODE_SINGLE.
|
||
public static
int
|
MODE_UPDATE Constant MODE_UPDATE.
|
||
public static
String
|
PARAM_CATEGORY_MARKER |
||
public static
String
|
PARAM_EXPORT |
||
public static
String
|
PARAM_IMPORT |
||
public static
String
|
PARAM_IO |
||
public static
String
|
PARAM_MENU_POSITION |
||
public static
String
|
PARAM_USE_OUTGOING_LINKS |
||
public static
String
|
PARAM_ZIP_ATTACHMENTS |
|
|||
public static
String
|
createZip(WikiEngine engine, String dataString, String filename, Collection pages)
|
||
protected
void
|
deletePages(WikiEngine engine, Collection pageNames)
Removes a collection of pages from the Wiki. Files get deleted in the filesystem.
This should have no disturbing effect on the running Wiki, but to be sure
use this operation only when the Wiki can be manually restarted afterwards.
|
||
protected
String
|
deriveFullTitle(String name, WikiPage wikipage, WikiEngine engine)
|
||
protected static
String
|
error(String s)
Formats a string as HTML-error message.
|
||
public
String
|
execute(WikiContext context, Map params)
Executes the plugin.
|
||
public
String
|
getProperty(WikiEngine engine, String propname)
Returns a property entry from the JSPWiki configuration file.
|
||
public
String
|
getProperty(WikiEngine engine, String propname, String defaultValue)
Returns a property entry from the JSPWiki configuration file.
|
||
public
String
|
getPropertyName(String propname)
Returns the property name for the specified sub-property.
This means that "jspwiki.archivename." will be preprended
to the propname.
|
||
protected static
String
|
hiddenfield(String name, String value)
Outputs an HTML-form-element for a hidden-field.
|
||
public static
void
|
pageEnd(HttpServletRequest request, HttpServletResponse response, JspWriter out)
Handles file downloads to the client.
To be invoked by a Servlet/JSP after any other part of the page has been generated.
If a download is to be performed, any previously generated page content will be removed.
(See end of ViewTemplate.jsp.)
|
||
public static
String
|
resolveZip(WikiEngine engine, String dataString, Map attachmentsToBeFilled)
|
||
protected static
String
|
selectbox(String name, Collection keys, Map labelsByKey, String value)
Outputs an HTML-form-element for a select-box.
|
||
private static
String
|
stackTrace(Throwable th)
|
||
protected static
void
|
updateAttachment(WikiEngine engine, String path, byte[] data)
|
||
protected static
void
|
updateAttachments(WikiEngine engine, Map attachments)
|
||
protected static
String
|
warning(String s)
Formats a string as HTML-warning message.
|
Tagged Values | |
static
|
false
|
documentation#author
|
Jens Gulden
|
|
public static final
String ATTRIBUTE_EXPORT_CONTENTDISPOSITION
public static final
String ATTRIBUTE_EXPORT_CONTENTTYPE
public static final
String ATTRIBUTE_EXPORT_RESULT
public static final
int BOTH
public static final
String CHARACTER_ENCODING
public static final
String DEFAULT_TEMP_DIR
public static final
int EXPORT
public static final
int IMPORT
public static final
int MODE_BOTH
public static final
int MODE_INSERT
public static final
int MODE_NONE
public static final
int MODE_SINGLE
public static final
int MODE_UPDATE
public static final
String PARAM_CATEGORY_MARKER
public static final
String PARAM_EXPORT
public static final
String PARAM_IMPORT
public static final
String PARAM_IO
public static final
String PARAM_MENU_POSITION
public static final
String PARAM_USE_OUTGOING_LINKS
public static final
String PARAM_ZIP_ATTACHMENTS
|
public static
String
createZip(WikiEngine engine, String dataString, String filename, Collection pages)
engine
-
dataString
-
filename
-
pages
-
protected
void deletePages(WikiEngine engine, Collection pageNames)
engine
- The WikiEngine.
pageNames
- The names of pages to be deleted.
protected
String
deriveFullTitle(String name, WikiPage wikipage, WikiEngine engine)
name
-
wikipage
-
engine
-
protected static
String
error(String s)
s
- The string to be formatted.
public
String
execute(WikiContext context, Map params)
Method Tagged Values | |
documentation#throws
|
PluginException if an error occurs
|
context
- The WikiContext.
params
- Parameters specified at plugin inclusion.
public
String
getProperty(WikiEngine engine, String propname)
engine
- The WikiEngine.
propname
- The propertyname, without leading "jspwiki.
public
String
getProperty(WikiEngine engine, String propname, String defaultValue)
engine
- The WikiEngine.
propname
- The propertyname, without leading "jspwiki.defaultValue
-
public
String
getPropertyName(String propname)
Method Tagged Values | |
documentation#see
|
#name
|
propname
- The sub-property name.
protected static
String
hiddenfield(String name, String value)
name
- The name of the field.
value
- The value of the field.
public static
void pageEnd(HttpServletRequest request, HttpServletResponse response, JspWriter out)
Method Tagged Values | |
documentation#throws
|
IOException if an i/o error occurs
|
request
- The http-request.
response
- The http-response.
out
- The page output writer.
public static
String
resolveZip(WikiEngine engine, String dataString, Map attachmentsToBeFilled)
engine
-
dataString
-
attachmentsToBeFilled
-
protected static
String
selectbox(String name, Collection keys, Map labelsByKey, String value)
name
- The name of the select-box element.
keys
- The value keys that are selectable by the select-box.
labelsByKey
- A map assigning displayable labels bto each value key.
The are the option texts presented to the user.
value
- The current value to be pre-selected.
private static
String
stackTrace(Throwable th)
th
-
protected static
void updateAttachment(WikiEngine engine, String path, byte[] data)
engine
-
path
-
data
-
protected static
void updateAttachments(WikiEngine engine, Map attachments)
engine
-
attachments
-
protected static
String
warning(String s)
s
- The string to be formatted.