info.magnolia.module.admininterface.pages
Class ExportPage

java.lang.Object
  info.magnolia.cms.servlets.MVCServletHandlerImpl
      info.magnolia.cms.servlets.CommandBasedMVCServletHandler
          info.magnolia.module.admininterface.PageMVCHandler
              info.magnolia.module.admininterface.TemplatedMVCHandler
                  info.magnolia.module.admininterface.pages.ExportPage

All Implemented Interfaces:

MVCServletHandler

Direct Known Subclasses:

ImportPage

public class ExportPage
extends TemplatedMVCHandler

Simple servlet used to import/export data from jcr using the standard jcr import/export features.

Version:

$Id: ExportPage.java 45868 2011-06-06 08:04:22Z ochytil $

Author:

Fabrizio Giustina

Field Summary

protected boolean	mgnlKeepVersions
protected java.lang.String	mgnlPath
protected java.lang.String	mgnlRepository
static java.lang.String	MIME_APPLICATION_ZIP
static java.lang.String	MIME_GZIP
static java.lang.String	MIME_TEXT_XML
static long	serialVersionUID Stable serialVersionUID.
static java.lang.String	VIEW_EXPORT View value for the export file stream (won't render anything)

Fields inherited from class info.magnolia.module.admininterface.PageMVCHandler

COMMAND_PARAMETER_NAME, COMMAND_SHOW, VIEW_SHOW

Fields inherited from class info.magnolia.cms.servlets.MVCServletHandlerImpl

exception, request, response, VIEW_ERROR, VIEW_SUCCESS

Fields inherited from interface info.magnolia.cms.servlets.MVCServletHandler

VIEW_NOTHING

Constructor Summary

ExportPage(java.lang.String name, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Method Summary

protected boolean	checkPermissions(javax.servlet.http.HttpServletRequest request, java.lang.String repository, java.lang.String basePath, long permissionType) Uses access manager to authorise this request.
java.lang.String	exportxml() Actually perform export.
java.lang.String	getCommand() Returns the name of the command we want to execute.
java.lang.String	getExt() Getter for ext.
Messages	getMessages()
java.lang.String	getMgnlPath() Getter for mgnlPath.
java.lang.String	getMgnlRepository() Getter for mgnlRepository.
java.util.Iterator	getRepositories()
boolean	isExportxml() Getter for exportxml.
boolean	isMgnlFormat() Getter for mgnlFormat.
boolean	isMgnlKeepVersions() Getter for mgnlKeepVersions.
void	renderHtml(java.lang.String view) Renders the template.
void	setExportxml(boolean exportxml) Setter for exportxml.
void	setExt(java.lang.String ext) Setter for ext.
void	setMgnlFormat(boolean mgnlFormat) Setter for mgnlFormat.
void	setMgnlKeepVersions(boolean mgnlKeepVersions) Setter for mgnlKeepVersions.
void	setMgnlPath(java.lang.String mgnlPath) Setter for mgnlPath.
void	setMgnlRepository(java.lang.String mgnlRepository) Setter for mgnlRepository.

Methods inherited from class info.magnolia.module.admininterface.TemplatedMVCHandler

getTemplateName

Methods inherited from class info.magnolia.module.admininterface.PageMVCHandler

getForm, getI18nBasename, getMsgs, getParams, init, setForm, setI18nBasename, setMsgs, setParams, show

Methods inherited from class info.magnolia.cms.servlets.CommandBasedMVCServletHandler

execute, findCommand, getCatalogueName, getCommandContext, getViewNameAfterExecution, setCatalogueName

Methods inherited from class info.magnolia.cms.servlets.MVCServletHandlerImpl

getException, getExceptionStackTrace, getName, getRequest, getResponse, populateFromRequest, setCommand, setRequest, setResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

Stable serialVersionUID.

See Also:

Constant Field Values

MIME_TEXT_XML

public static final java.lang.String MIME_TEXT_XML

See Also:

Constant Field Values

MIME_GZIP

public static final java.lang.String MIME_GZIP

See Also:

Constant Field Values

MIME_APPLICATION_ZIP

public static final java.lang.String MIME_APPLICATION_ZIP

See Also:

Constant Field Values

VIEW_EXPORT

public static final java.lang.String VIEW_EXPORT

View value for the export file stream (won't render anything)

See Also:

Constant Field Values

mgnlRepository

protected java.lang.String mgnlRepository

mgnlPath

protected java.lang.String mgnlPath

mgnlKeepVersions

protected boolean mgnlKeepVersions

Constructor Detail

ExportPage

public ExportPage(java.lang.String name,
                  javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)

Parameters:

name -

request -

response -

Method Detail

getExt

public java.lang.String getExt()

Getter for ext.

Returns:

Returns the ext.

setExt

public void setExt(java.lang.String ext)

Setter for ext.

Parameters:

ext - The ext to set.

isMgnlFormat

public boolean isMgnlFormat()

Getter for mgnlFormat.

Returns:

Returns the mgnlFormat.

setMgnlFormat

public void setMgnlFormat(boolean mgnlFormat)

Setter for mgnlFormat.

Parameters:

mgnlFormat - The mgnlFormat to set.

isMgnlKeepVersions

public boolean isMgnlKeepVersions()

Getter for mgnlKeepVersions.

Returns:

Returns the mgnlKeepVersions.

setMgnlKeepVersions

public void setMgnlKeepVersions(boolean mgnlKeepVersions)

Setter for mgnlKeepVersions.

Parameters:

mgnlKeepVersions - The mgnlKeepVersions to set.

getMgnlPath

public java.lang.String getMgnlPath()

Getter for mgnlPath.

Returns:

Returns the mgnlPath.

setMgnlPath

public void setMgnlPath(java.lang.String mgnlPath)

Setter for mgnlPath.

Parameters:

mgnlPath - The mgnlPath to set.

getMgnlRepository

public java.lang.String getMgnlRepository()

Getter for mgnlRepository.

Returns:

Returns the mgnlRepository.

setMgnlRepository

public void setMgnlRepository(java.lang.String mgnlRepository)

Setter for mgnlRepository.

Parameters:

mgnlRepository - The mgnlRepository to set.

isExportxml

public boolean isExportxml()

Getter for exportxml.

Returns:

Returns the exportxml.

setExportxml

public void setExportxml(boolean exportxml)

Setter for exportxml.

Parameters:

exportxml - The exportxml to set.

getCommand

public java.lang.String getCommand()

Description copied from interface: MVCServletHandler

Returns the name of the command we want to execute.

Specified by:

getCommand in interface MVCServletHandler

Overrides:

getCommand in class MVCServletHandlerImpl

Returns:

Returns the command.

See Also:

MVCServletHandlerImpl.getCommand()

exportxml

public java.lang.String exportxml()
                           throws java.lang.Exception

Actually perform export. The generated file is sent to the client.

Parameters:

response - HttpServletResponse

repository - selected repository

basepath - base path in repository

format - should we format the resulting xml

keepVersionHistory - if false version info will be stripped from the exported document

Throws:

java.io.IOException - for errors while accessing the servlet output stream

java.lang.Exception

checkPermissions

protected boolean checkPermissions(javax.servlet.http.HttpServletRequest request,
                                   java.lang.String repository,
                                   java.lang.String basePath,
                                   long permissionType)

Uses access manager to authorise this request.

Parameters:

request - HttpServletRequest as received by the service method

Returns:

boolean true if read access is granted

renderHtml

public void renderHtml(java.lang.String view)
                throws java.io.IOException

Description copied from class: TemplatedMVCHandler

Renders the template. The handlers is passed with the name 'this'.

Specified by:

renderHtml in interface MVCServletHandler

Overrides:

renderHtml in class TemplatedMVCHandler

Throws:

java.io.IOException

getMessages

public Messages getMessages()

getRepositories

public java.util.Iterator getRepositories()