Package com.uc4.communication.requests

Class ExportObject

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ExportObject

public class ExportObject
extends XMLRequest

Exports an UC4 Object.

Constructor Summary

Constructors

Constructor	Description
ExportObject(IFolder[] folders, java.io.File export, boolean exportLinks)	Exports a list of UC4 Folders.
ExportObject(IFolder folder, java.io.File export, boolean exportLinks)	Exports a single folder structure.
ExportObject(UC4ObjectName[] names, java.io.File export)	Exports a list of UC4 Objects.
ExportObject(UC4ObjectName[] names, java.util.List<IFolder> folders, java.io.File export, boolean exportLinks)	Export given folder list and objects
ExportObject(UC4ObjectName name, java.io.File export)	Exports a single Object.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
java.nio.ByteBuffer	getBinaryContent()	Returns the file content as ByteBuffer.
java.lang.Exception	getExportException()	Returns the Exception that occured during the export or null if the export was successful.
ImportObject	getImportRequest(IFolder folder, boolean overwriteObject, boolean keepFolderLinks)	Creates an ImportObject request from the export.
java.util.Iterator<DownloadBinary>	getResourceList()	Returns an Iterator with items of DownloadBinary objects after invoking the ExportObject instance.
protected java.lang.String	getSrc()	Returns the request source.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
protected boolean	isAllowedInClientZero()	This method is used internally.
void	setExportLinksEnabled(boolean exportLinksEnabled)	Sets the export links enabled.
boolean	wasSuccessful()	Returns true if the file was saved successfully.
protected void	writeExportXml(com.uc4.util.XMLDocument doc, java.io.OutputStream out, ConnectionAttributes session, boolean isExportAsFile)

Methods inherited from class com.uc4.communication.requests.XMLRequest

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportObject

public ExportObject(UC4ObjectName name,
                    java.io.File export)

Exports a single Object.

Parameters:

name - Name of the UC4 Object

export - Export file

ExportObject

public ExportObject(UC4ObjectName[] names,
                    java.io.File export)

Exports a list of UC4 Objects.

Parameters:

names - UC4 Objects which should be exported

export - Export file

ExportObject

public ExportObject(UC4ObjectName[] names,
                    java.util.List<IFolder> folders,
                    java.io.File export,
                    boolean exportLinks)

Export given folder list and objects

Parameters:

names - UC4 Objects which should be exported

folders - UC4 folder Objects which should be exported

export - Export file

exportLinks - includes objects where the home folder is not the export folder but as an link inside

ExportObject

public ExportObject(IFolder folder,
                    java.io.File export,
                    boolean exportLinks)

Exports a single folder structure.

Parameters:

folder - UC4 folder Object which should be exported

export - Export file

exportLinks - includes objects where the home folder is not the export folder but as an link inside

ExportObject

public ExportObject(IFolder[] folders,
                    java.io.File export,
                    boolean exportLinks)

Exports a list of UC4 Folders.

Parameters:

folders - UC4 Folders which should be exported

export - Export file

exportLinks - includes objects where the home folder is not the export folder but as an link inside

Method Detail

getImportRequest

public ImportObject getImportRequest(IFolder folder,
                                     boolean overwriteObject,
                                     boolean keepFolderLinks)

Creates an ImportObject request from the export.

Parameters:

folder - Destination folder

overwriteObject - flag to define if the object should be overwritten

keepFolderLinks - If true, existing folder links will be kept

Returns:

ImportObject request or null if the output is saved in a file.

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.Element request,
                             ConnectionAttributes sessionInfo)

Description copied from class: XMLRequest

Creates the XML Document for the request. This method is used internally.

Specified by:

createRequest in class XMLRequest

Parameters:

doc - Document, used to create new Elements

request - Request Element - classes append information to this request element

sessionInfo - Information about the session

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
                             ConnectionAttributes session)

Description copied from class: XMLRequest

Sub classes extract the values from the XML document and provide public getter methods.

Overrides:

handleContent in class XMLRequest

Parameters:

doc - XML Document

session - Info about the user session

writeExportXml

protected void writeExportXml(com.uc4.util.XMLDocument doc,
                              java.io.OutputStream out,
                              ConnectionAttributes session,
                              boolean isExportAsFile)
                       throws java.io.IOException

Throws:

java.io.IOException

wasSuccessful

public boolean wasSuccessful()

Returns true if the file was saved successfully. If this method returns false the method getExportException can be used to get the exception which occured during the export.

Returns:

True if the objects where successfully exported

getExportException

public java.lang.Exception getExportException()

Returns the Exception that occured during the export or null if the export was successful.

Returns:

Export exception or null

getBinaryContent

public java.nio.ByteBuffer getBinaryContent()

Returns the file content as ByteBuffer.

Returns:

file content

setExportLinksEnabled

public void setExportLinksEnabled(boolean exportLinksEnabled)

Sets the export links enabled.

Parameters:

exportLinksEnabled - the new export links enabled

getSrc

protected java.lang.String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

isAllowedInClientZero

protected boolean isAllowedInClientZero()

Description copied from class: XMLRequest

This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.

Overrides:

isAllowedInClientZero in class XMLRequest

Returns:

true if this request is allowed in client 0, false otherwise

getResourceList

public java.util.Iterator<DownloadBinary> getResourceList()

Returns an Iterator with items of DownloadBinary objects after invoking the ExportObject instance. Use this Iterator to additionally download all related resource items of each STORE object containing within the export.

Returns:

An Iterator containing all resource items of each exported STORE object.