Package org.pentaho.platform.plugin.services.importexport.exportManifest

Class ExportManifest

java.lang.Object

org.pentaho.platform.plugin.services.importexport.exportManifest.ExportManifest

public class ExportManifest
extends Object

The Primary Object which represents the ExportManifest XML file by the same name stored in the Repository Export zip file during a repository export.

Author:

tkafalas

Constructor Summary

Constructors

Constructor	Description
ExportManifest()
ExportManifest(ExportManifestDto exportManifestDto)

Method Summary

Modifier and Type	Method	Description
void	add(File file, String userId, String projectId, Boolean isFolder, Boolean isHidden, Boolean isSchedulable)
void	add(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile, org.pentaho.platform.api.repository2.unified.RepositoryFileAcl repositoryFileAcl)
void	addDatasource(DatabaseConnection connection)
void	addGlobalUserSetting(ExportManifestUserSetting globalSetting)
void	addMetadata(ExportManifestMetadata metadata)
void	addMondrian(ExportManifestMondrian mondrian)
void	addRoleExport(RoleExport roleExport)
void	addSchedule(JobScheduleRequest schedule)
void	addUserExport(UserExport userExport)
ExportManifestEntity	createExportManifestEntry()	Factory method to deliver one ExportManifestEntity.
ExportManifestDto.ExportManifestInformation	createExportManifestInformation()
static ExportManifest	fromXml(ByteArrayInputStream input)
List<DatabaseConnection>	getDatasourceList()
HashMap<String,ExportManifestEntity>	getExportManifestEntities()	Return entire map of export manifest entities
ExportManifestEntity	getExportManifestEntity(String path)
List<ExportManifestUserSetting>	getGlobalUserSettings()
ExportManifestDto.ExportManifestInformation	getManifestInformation()
List<ExportManifestMetadata>	getMetadataList()
ExportManifestMetaStore	getMetaStore()
List<ExportManifestMondrian>	getMondrianList()
List<RoleExport>	getRoleExports()
List<JobScheduleRequest>	getScheduleList()
List<UserExport>	getUserExports()
boolean	isValid()
void	setManifestInformation(ExportManifestDto.ExportManifestInformation manifestInformation)
void	setMetaStore(ExportManifestMetaStore metaStore)
void	toXml(OutputStream outputStream)	Marshals the manifest object into xml on the given output stream
String	toXmlString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportManifest

public ExportManifest()

ExportManifest

public ExportManifest(ExportManifestDto exportManifestDto)

Method Detail

add

public void add(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile,
                org.pentaho.platform.api.repository2.unified.RepositoryFileAcl repositoryFileAcl)
         throws ExportManifestFormatException

Parameters:

repositoryFile -

repositoryFileAcl -

Throws:

ExportManifestFormatException - if the RepositoryFile path does not start with the manifest's rootFolder of manifest is

add

public void add(File file,
                String userId,
                String projectId,
                Boolean isFolder,
                Boolean isHidden,
                Boolean isSchedulable)
         throws ExportManifestFormatException

Throws:

ExportManifestFormatException

getExportManifestEntities

public HashMap<String,ExportManifestEntity> getExportManifestEntities()

Return entire map of export manifest entities

Returns:

getExportManifestEntity

public ExportManifestEntity getExportManifestEntity(String path)

toXml

public void toXml(OutputStream outputStream)
           throws JAXBException,
                  ExportManifestFormatException

Marshals the manifest object into xml on the given output stream

Parameters:

outputStream -

Throws:

JAXBException

ExportManifestFormatException

toXmlString

public String toXmlString()
                   throws JAXBException

Throws:

JAXBException

fromXml

public static ExportManifest fromXml(ByteArrayInputStream input)
                              throws JAXBException

Throws:

JAXBException

createExportManifestEntry

public ExportManifestEntity createExportManifestEntry()

Factory method to deliver one ExportManifestEntity. The Manifest is built by adding one ExportManifestEntity object for each file and folder in the export set.

Returns:

isValid

public boolean isValid()

getManifestInformation

public ExportManifestDto.ExportManifestInformation getManifestInformation()

Returns:

the manifestInformation

setManifestInformation

public void setManifestInformation(ExportManifestDto.ExportManifestInformation manifestInformation)

Parameters:

manifestInformation - the manifestInformation to set

createExportManifestInformation

public ExportManifestDto.ExportManifestInformation createExportManifestInformation()

addMetadata

public void addMetadata(ExportManifestMetadata metadata)

addMondrian

public void addMondrian(ExportManifestMondrian mondrian)

addSchedule

public void addSchedule(JobScheduleRequest schedule)

addDatasource

public void addDatasource(DatabaseConnection connection)

getMetadataList

public List<ExportManifestMetadata> getMetadataList()

getMondrianList

public List<ExportManifestMondrian> getMondrianList()

getScheduleList

public List<JobScheduleRequest> getScheduleList()

getDatasourceList

public List<DatabaseConnection> getDatasourceList()

getUserExports

public List<UserExport> getUserExports()

addUserExport

public void addUserExport(UserExport userExport)

getRoleExports

public List<RoleExport> getRoleExports()

addRoleExport

public void addRoleExport(RoleExport roleExport)

setMetaStore

public void setMetaStore(ExportManifestMetaStore metaStore)

getMetaStore

public ExportManifestMetaStore getMetaStore()

getGlobalUserSettings

public List<ExportManifestUserSetting> getGlobalUserSettings()

addGlobalUserSetting

public void addGlobalUserSetting(ExportManifestUserSetting globalSetting)