Class DefaultExportContext
- java.lang.Object
-
- com.atlassian.confluence.importexport.DefaultExportContext
-
- All Implemented Interfaces:
ExportContext
@Deprecated public class DefaultExportContext extends Object implements ExportContext
Deprecated.since 7.17.0. UserBackupRestoreManager
instead.
-
-
Constructor Summary
Constructors Constructor Description DefaultExportContext()
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addExceptionEntities(List<ConfluenceEntityObject> entities, boolean validate)
Deprecated.Helper method to add a collection of entities to the current exception entitiesvoid
addExceptionEntity(ConfluenceEntityObject entity)
Deprecated.void
addWorkingEntity(ConfluenceEntityObject entity)
Deprecated.Add to the entities to be exported.ContentTree
getContentTree()
Deprecated.List<ConfluenceEntityObject>
getExceptionEntities()
Deprecated.File
getExportDirectory()
Deprecated.ExportScope
getExportScope()
Deprecated.Set
getProcessedIds()
Deprecated.String
getSpaceKey()
Deprecated.String
getSpaceKeyOfSpaceExport()
Deprecated.String
getType()
Deprecated.com.atlassian.user.User
getUser()
Deprecated.List<ConfluenceEntityObject>
getWorkingEntities()
Deprecated.The top level entities to be exported.static DefaultExportContext
getXmlBackupInstance()
Deprecated.boolean
isExceptionEntity(ConfluenceEntityObject entity)
Deprecated.Entities to be excluded from the export.boolean
isExportAll()
Deprecated.boolean
isExportAttachments()
Deprecated.boolean
isExportComments()
Deprecated.boolean
isExportHierarchy()
Deprecated.boolean
isPageInExport(Page page, PageManager pageManager)
Deprecated.void
setContentTree(ContentTree contentTree)
Deprecated.void
setExportAll(boolean exportAll)
Deprecated.void
setExportAttachments(boolean exportAttachments)
Deprecated.void
setExportComments(boolean exportComments)
Deprecated.void
setExportDirectory(File exportDirectory)
Deprecated.void
setExportHierarchy(boolean exportHierarchy)
Deprecated.void
setExportScope(ExportScope scope)
Deprecated.void
setSpaceKey(String spaceKey)
Deprecated.void
setType(String type)
Deprecated.void
setUser(com.atlassian.user.User user)
Deprecated.
-
-
-
Method Detail
-
getXmlBackupInstance
public static DefaultExportContext getXmlBackupInstance()
Deprecated.
-
addWorkingEntity
public void addWorkingEntity(ConfluenceEntityObject entity)
Deprecated.Add to the entities to be exported. This entity will be exported and its children and components may be too.
-
addExceptionEntities
public void addExceptionEntities(List<ConfluenceEntityObject> entities, boolean validate) throws IllegalArgumentException
Deprecated.Helper method to add a collection of entities to the current exception entities- Parameters:
entities
- a list of ConfluenceEntityObjectsvalidate
- - if true the contents of the list will be type-checked to ensure that they contain nothing other thanConfluenceEntityObject
.- Throws:
IllegalArgumentException
- if the list contains somethingConfluenceEntityObject
and validation is turned on.
-
addExceptionEntity
public void addExceptionEntity(ConfluenceEntityObject entity)
Deprecated.
-
isPageInExport
public boolean isPageInExport(Page page, PageManager pageManager)
Deprecated.- Specified by:
isPageInExport
in interfaceExportContext
- Returns:
- true if the given page is part of the current export, otherwise false.
-
getExceptionEntities
public List<ConfluenceEntityObject> getExceptionEntities()
Deprecated.
-
getWorkingEntities
public List<ConfluenceEntityObject> getWorkingEntities()
Deprecated.Description copied from interface:ExportContext
The top level entities to be exported. Their children and components will usually be exported too.- Specified by:
getWorkingEntities
in interfaceExportContext
-
getProcessedIds
public Set getProcessedIds()
Deprecated.- Specified by:
getProcessedIds
in interfaceExportContext
-
setUser
public void setUser(com.atlassian.user.User user)
Deprecated.
-
getUser
public com.atlassian.user.User getUser()
Deprecated.- Specified by:
getUser
in interfaceExportContext
- Returns:
- the user this export is being generated for.
-
getSpaceKeyOfSpaceExport
public String getSpaceKeyOfSpaceExport()
Deprecated.- Specified by:
getSpaceKeyOfSpaceExport
in interfaceExportContext
- Returns:
- if this is a space export, the key of the space being exported, otherwise null
-
isExceptionEntity
public boolean isExceptionEntity(ConfluenceEntityObject entity)
Deprecated.Description copied from interface:ExportContext
Entities to be excluded from the export.- Specified by:
isExceptionEntity
in interfaceExportContext
-
isExportComments
public boolean isExportComments()
Deprecated.- Specified by:
isExportComments
in interfaceExportContext
-
setExportComments
public void setExportComments(boolean exportComments)
Deprecated.
-
isExportAttachments
public boolean isExportAttachments()
Deprecated.- Specified by:
isExportAttachments
in interfaceExportContext
-
setExportAttachments
public void setExportAttachments(boolean exportAttachments)
Deprecated.- Specified by:
setExportAttachments
in interfaceExportContext
-
isExportHierarchy
public boolean isExportHierarchy()
Deprecated.- Specified by:
isExportHierarchy
in interfaceExportContext
-
setExportHierarchy
public void setExportHierarchy(boolean exportHierarchy)
Deprecated.- Specified by:
setExportHierarchy
in interfaceExportContext
-
getExportDirectory
public File getExportDirectory()
Deprecated.
-
setExportDirectory
public void setExportDirectory(File exportDirectory)
Deprecated.
-
getContentTree
public ContentTree getContentTree()
Deprecated.- Returns:
- tree of ContentNodes to export (each ContentNode holds a page object), permission checking should already be applied to this tree when the context is passed to the Exporter.
- See Also:
ContentTree
-
setContentTree
public void setContentTree(ContentTree contentTree)
Deprecated.
-
getType
public String getType()
Deprecated.- Specified by:
getType
in interfaceExportContext
- Returns:
- the type of the export: HTML, PDF or XML. These constants are defined above.
-
setType
public void setType(String type)
Deprecated.
-
getExportScope
public ExportScope getExportScope()
Deprecated.- Specified by:
getExportScope
in interfaceExportContext
- Returns:
- the scope of an XML export: global, space or page.
-
setExportScope
public void setExportScope(ExportScope scope)
Deprecated.
-
isExportAll
public boolean isExportAll()
Deprecated.
-
setExportAll
public void setExportAll(boolean exportAll)
Deprecated.
-
getSpaceKey
public String getSpaceKey()
Deprecated.
-
setSpaceKey
public void setSpaceKey(String spaceKey)
Deprecated.
-
-