com.atlassian.confluence.it.export

Class SimpleSiteStructure

java.lang.Object

com.atlassian.confluence.it.export.SimpleSiteStructure

public class SimpleSiteStructure
extends Object

A simple representation of an exported Confluence site providing an easy way to validate site exports in acceptance tests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleSiteStructure.AttachmentRepresentation
static class	SimpleSiteStructure.ContentRepresentation
static interface	SimpleSiteStructure.ExportableItem
static class	SimpleSiteStructure.IdentifiedRepresentation
static class	SimpleSiteStructure.PageRepresentation
static class	SimpleSiteStructure.SpaceRepresentation
static class	SimpleSiteStructure.UserRepresentation The representation of a Confluence user in the export file

Constructor Summary

Constructors

Constructor and Description
SimpleSiteStructure()

Method Summary

Modifier and Type	Method and Description
void	add(SimpleSiteStructure.ExportableItem rep)
void	addAttachmentData(String name, InputStream inputStream)
static SimpleSiteStructure	createFromStream(InputStream str) Utility method to create a SimpleSiteStructure as represented by the supplied InputStream.
Set<SimpleSiteStructure.AttachmentRepresentation>	getAllAttachments()
String	getAttachmentData(SimpleSiteStructure.AttachmentRepresentation attachment, int version)
SimpleSiteStructure.PageRepresentation	getPageFromSpaceWithTitle(String spaceKey, String title)
boolean	hasAnonymizedUser(String username)
boolean	hasPage(AbstractPageEntity page)
boolean	hasUserWithEmail(String username)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleSiteStructure

public SimpleSiteStructure()

Method Detail

add

public void add(SimpleSiteStructure.ExportableItem rep)

Parameters:

rep - the object to be stored in the structure.

getPageFromSpaceWithTitle

public SimpleSiteStructure.PageRepresentation getPageFromSpaceWithTitle(String spaceKey,
                                                                        String title)

Parameters:

spaceKey - the key of the space the page is found in

title - the title of the page

Returns:

a Page representation for the specified page in the specified space, or null if there is none.

hasUserWithEmail

public boolean hasUserWithEmail(String username)

hasAnonymizedUser

public boolean hasAnonymizedUser(String username)

hasPage

public boolean hasPage(AbstractPageEntity page)

getAllAttachments

public Set<SimpleSiteStructure.AttachmentRepresentation> getAllAttachments()

Returns:

all attachments found in the export

createFromStream

public static SimpleSiteStructure createFromStream(InputStream str)
                                            throws Exception

Utility method to create a SimpleSiteStructure as represented by the supplied InputStream.

Parameters:

str - the stream to parse.

Returns:

the SimpleSiteStructure represented by this stream.

Throws:

Exception

addAttachmentData

public void addAttachmentData(String name,
                              InputStream inputStream)
                       throws IOException

Throws:

IOException

getAttachmentData

public String getAttachmentData(SimpleSiteStructure.AttachmentRepresentation attachment,
                                int version)