|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jaspersoft.jasperserver.util.ExportResource
public class ExportResource
This module handles the exporting of metadata from the JasperServer repository to an XML file. This XML file and the binary data that is written to disk is used to import to a target repository. Users can specify which resources in the repository are desired for export. For example, this can be a FileResource (such as an image, jrxml, etc), a ReportUnit, a DataSource, a Folder, etc. If the exported resource is a folder, all of the files and folders will be recursively exported. The attributes of the resource are written to a "bean" representation class. This class is processed (unmarshalled) by the Castor library to turn it directly into XML. This process is very straightforward for an object such as a DataSource which does not contain any binary information. However, for a FileResource such as an image, a jar, or even a JRXML, this module must manage the writing out of this binary (or in the case of JRXML, text data) information to disk in order to save it. Binary data is written out to disk and saved under a folder/directory structure that matches the repository URI structure specified by the uriString member variable for each resource. A typical export structure would look like the following: ji-catalog/ji-catalog.xml - xml file describing all exported resources /dir1/dir2/myImage - data on disk /dir1/dir2/myJrxml - data on disk /dir1/dir2/myClassJar - data on disk There is a heirarchy of bean objects that can hold each of the exported resources. The highest level bean object is ExportImportBean.
Field Summary | |
---|---|
static java.lang.String |
CATALOG_DIR_NAME
|
static java.lang.String |
CATALOG_FILE_NAME
|
static boolean |
NOT_TOP_LEVEL_OBJECT
|
static java.lang.String |
PATH_SEP
|
static java.lang.String |
PRODUCT_VERSION
|
static java.lang.String |
PRODUCT_VERSION_0_9_2
|
static java.lang.String |
PRODUCT_VERSION_1_0
|
static java.lang.String |
PRODUCT_VERSION_1_1_0
|
static boolean |
TOP_LEVEL_OBJECT
|
Constructor Summary | |
---|---|
ExportResource(RepositoryService repo,
UserAuthorityService userAuthService,
ReportSchedulingService reportSchedulingService,
ExecutionContext context,
java.lang.String startUri,
boolean processUsersRoles,
java.lang.String[] userNames,
java.lang.String[] roleNames,
boolean processReportJobs,
java.lang.String[] reportJobUnitNames,
java.lang.String catalogDirName,
java.lang.String catalogFileName)
|
|
ExportResource(RepositoryService repo,
UserAuthorityService userAuthService,
ReportSchedulingService reportSchedulingService,
ExecutionContext context,
java.lang.String startUri,
boolean processUsersRoles,
java.lang.String[] userNames,
java.lang.String[] roleNames,
boolean processReportJobs,
java.lang.String[] reportJobUnitNames,
java.lang.String catalogDirName,
java.lang.String catalogFileName,
java.lang.String characterEncoding)
Constructor |
Method Summary | |
---|---|
protected void |
checkForProcessing()
|
protected void |
checkForUserRoleProcessing()
Determine the processing operations for Users and Roles. |
protected java.io.File |
createParentPath(ResourceBean bean)
Create a path on disk. |
Resource |
dereference(ExecutionContext mContext,
ResourceReference ref)
|
protected void |
fillBean(ContentResourceBean bean,
ContentResource contentResource)
|
protected void |
fillBean(DataTypeBean bean,
DataType dt)
|
protected void |
fillBean(FileResourceBean bean,
FileResource fileResource)
|
protected void |
fillBean(InputControlBean bean,
InputControl ic)
|
protected void |
fillBean(JdbcDataSourceBean bean,
JdbcReportDataSource dataSource)
|
protected void |
fillBean(JndiJdbcDataSourceBean bean,
JndiJdbcReportDataSource dataSource)
|
protected void |
fillBean(ListOfValuesBean bean,
ListOfValues listOfValues)
|
protected void |
fillBean(MondrianConnectionBean bean,
MondrianConnection conn)
|
protected void |
fillBean(MondrianXmlaDefinitionBean bean,
MondrianXMLADefinition xDef)
|
protected void |
fillBean(OlapUnitBean bean,
OlapUnit unit)
|
protected void |
fillBean(QueryBean bean,
Query query)
|
protected void |
fillBean(XmlaConnectionBean bean,
XMLAConnection conn)
|
protected void |
fillCommonBeanFields(ResourceBean bean,
Resource res)
Set the member vars found in the ResourceBean |
protected RoleBean[] |
getRolesFromUser(User user)
|
protected UserBean[] |
getUsersFromRole(RoleBean[] exportRoleBeans)
|
protected InputControlBean[] |
handleInputControls(ReportUnit unit,
boolean isTopLevel)
|
protected ResourceBean[] |
handleResourcesInFolder(Folder folder)
|
RoleBean[] |
handleRoles(java.lang.String[] rolenames,
boolean isTopLevel)
|
protected FolderBean[] |
handleSubFolders(Folder topFolder)
|
UserBean[] |
handleUsers(java.lang.String[] usernames,
boolean isTopLevel)
|
static void |
main(java.lang.String[] args)
|
void |
process()
|
ContentResourceBean |
process(ContentResource contentResource,
boolean isTopLevel)
|
DataSourceBean |
process(DataSource dataSource,
boolean isTopLevel)
|
DataTypeBean |
process(DataType dataType,
boolean isTopLevel)
|
FileResourceBean |
process(FileResource fileResource,
boolean isTopLevel)
|
FolderBean |
process(Folder topFolder,
boolean isTopLevel)
|
InputControlBean |
process(InputControl inputControl,
boolean isTopLevel)
|
JdbcDataSourceBean |
process(JdbcReportDataSource dataSource,
boolean isTopLevel)
|
JndiJdbcDataSourceBean |
process(JndiJdbcReportDataSource dataSource,
boolean isTopLevel)
|
ListOfValuesBean |
process(ListOfValues listOfValues,
boolean isTopLevel)
|
MondrianConnectionBean |
process(MondrianConnection conn,
boolean isTopLevel)
|
MondrianXmlaDefinitionBean |
process(MondrianXMLADefinition xDef,
boolean isTopLevel)
|
OlapClientConnectionBean |
process(OlapClientConnection conn,
boolean isTopLevel)
|
OlapUnitBean |
process(OlapUnit unit,
boolean isTopLevel)
|
QueryBean |
process(Query query,
boolean isTopLevel)
|
ReportJobBean |
process(ReportJob job,
boolean isTopLevel)
|
ReportUnitBean |
process(ReportUnit reportUnit,
boolean isTopLevel)
|
XmlaConnectionBean |
process(XMLAConnection conn,
boolean isTopLevel)
|
UserRoleHolderBean |
processAllUsersRoles(boolean isTopLevel)
|
void |
processFolder(Folder folder,
FolderBean bean)
|
UserRoleHolderBean |
processNamedRoles(java.lang.String[] rolenames,
boolean isTopLevel)
Processing of named roles is a bit different than similar processing for users. |
UserRoleHolderBean |
processNamedUsers(java.lang.String[] usernames,
boolean isTopLevel)
|
UserRoleHolderBean |
processNamedUsersRoles(java.lang.String[] usernames,
java.lang.String[] rolenames,
boolean isTopLevel)
|
void |
processReportJobs(boolean isTopLevel)
Main processing routine for Report Jobs (ie scheduled reports). |
void |
processUri()
Main processing routine for all repository resources that inherit from the Resource interface (and are handled by the RepositoryService). |
void |
processUsersRoles()
Main processing routine for Users and Roles. |
protected void |
writeCatalogData(ContentResourceBean bean)
|
protected void |
writeCatalogData(FileResourceBean bean)
|
protected void |
writeCatalogData(FolderBean bean)
|
protected void |
writeCatalogData(MondrianXmlaDefinitionBean bean)
|
protected void |
writeCatalogData(OlapClientConnectionBean bean)
|
protected void |
writeCatalogData(OlapUnitBean bean)
|
protected void |
writeCatalogData(ReportUnitBean bean)
|
protected void |
writeCatalogDataFolder(FolderBean bean)
|
protected void |
writeCatalogDataMainReport(FileResourceBean bean)
|
protected void |
writeCatalogFile(ExportImportBean bean)
Write out the ji-catalog xml file |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PATH_SEP
public static final java.lang.String CATALOG_DIR_NAME
public static final java.lang.String CATALOG_FILE_NAME
public static final java.lang.String PRODUCT_VERSION_1_0
public static final java.lang.String PRODUCT_VERSION_0_9_2
public static final java.lang.String PRODUCT_VERSION_1_1_0
public static final java.lang.String PRODUCT_VERSION
public static final boolean TOP_LEVEL_OBJECT
public static final boolean NOT_TOP_LEVEL_OBJECT
Constructor Detail |
---|
public ExportResource(RepositoryService repo, UserAuthorityService userAuthService, ReportSchedulingService reportSchedulingService, ExecutionContext context, java.lang.String startUri, boolean processUsersRoles, java.lang.String[] userNames, java.lang.String[] roleNames, boolean processReportJobs, java.lang.String[] reportJobUnitNames, java.lang.String catalogDirName, java.lang.String catalogFileName)
public ExportResource(RepositoryService repo, UserAuthorityService userAuthService, ReportSchedulingService reportSchedulingService, ExecutionContext context, java.lang.String startUri, boolean processUsersRoles, java.lang.String[] userNames, java.lang.String[] roleNames, boolean processReportJobs, java.lang.String[] reportJobUnitNames, java.lang.String catalogDirName, java.lang.String catalogFileName, java.lang.String characterEncoding)
repo
- userAuthService
- reportSchedulingService
- context
- startUri
- processUsersRoles
- userNames
- roleNames
- processReportJobs
- reportJobUnitNames
- catalogDirName
- catalogFile
- Method Detail |
---|
public static void main(java.lang.String[] args)
args
- protected void checkForProcessing()
public void process()
public void processUri()
public void processUsersRoles()
public void processReportJobs(boolean isTopLevel)
public FolderBean process(Folder topFolder, boolean isTopLevel)
public void processFolder(Folder folder, FolderBean bean)
public FileResourceBean process(FileResource fileResource, boolean isTopLevel)
public ContentResourceBean process(ContentResource contentResource, boolean isTopLevel)
public ReportUnitBean process(ReportUnit reportUnit, boolean isTopLevel)
public OlapUnitBean process(OlapUnit unit, boolean isTopLevel)
public OlapClientConnectionBean process(OlapClientConnection conn, boolean isTopLevel)
public XmlaConnectionBean process(XMLAConnection conn, boolean isTopLevel)
public MondrianConnectionBean process(MondrianConnection conn, boolean isTopLevel)
public MondrianXmlaDefinitionBean process(MondrianXMLADefinition xDef, boolean isTopLevel)
public DataSourceBean process(DataSource dataSource, boolean isTopLevel)
public JdbcDataSourceBean process(JdbcReportDataSource dataSource, boolean isTopLevel)
public JndiJdbcDataSourceBean process(JndiJdbcReportDataSource dataSource, boolean isTopLevel)
public InputControlBean process(InputControl inputControl, boolean isTopLevel)
public QueryBean process(Query query, boolean isTopLevel)
public DataTypeBean process(DataType dataType, boolean isTopLevel)
public ListOfValuesBean process(ListOfValues listOfValues, boolean isTopLevel)
public ReportJobBean process(ReportJob job, boolean isTopLevel)
public UserRoleHolderBean processAllUsersRoles(boolean isTopLevel)
public UserRoleHolderBean processNamedUsers(java.lang.String[] usernames, boolean isTopLevel)
public UserRoleHolderBean processNamedRoles(java.lang.String[] rolenames, boolean isTopLevel)
rolenames
- isTopLevel
-
public UserRoleHolderBean processNamedUsersRoles(java.lang.String[] usernames, java.lang.String[] rolenames, boolean isTopLevel)
public UserBean[] handleUsers(java.lang.String[] usernames, boolean isTopLevel)
public RoleBean[] handleRoles(java.lang.String[] rolenames, boolean isTopLevel)
protected RoleBean[] getRolesFromUser(User user)
protected UserBean[] getUsersFromRole(RoleBean[] exportRoleBeans)
protected InputControlBean[] handleInputControls(ReportUnit unit, boolean isTopLevel)
protected FolderBean[] handleSubFolders(Folder topFolder)
protected ResourceBean[] handleResourcesInFolder(Folder folder)
protected void checkForUserRoleProcessing()
protected void writeCatalogFile(ExportImportBean bean)
bean
- protected void writeCatalogData(FolderBean bean)
protected void writeCatalogDataFolder(FolderBean bean)
protected void writeCatalogData(ReportUnitBean bean)
protected void writeCatalogData(OlapUnitBean bean)
protected void writeCatalogData(OlapClientConnectionBean bean)
protected void writeCatalogData(MondrianXmlaDefinitionBean bean)
protected void writeCatalogDataMainReport(FileResourceBean bean)
protected void writeCatalogData(FileResourceBean bean)
protected void writeCatalogData(ContentResourceBean bean)
protected java.io.File createParentPath(ResourceBean bean)
ResourceBean
-
public Resource dereference(ExecutionContext mContext, ResourceReference ref)
protected void fillCommonBeanFields(ResourceBean bean, Resource res)
uri
-
java.lang.Exception
protected void fillBean(FileResourceBean bean, FileResource fileResource)
protected void fillBean(ContentResourceBean bean, ContentResource contentResource)
protected void fillBean(JdbcDataSourceBean bean, JdbcReportDataSource dataSource)
protected void fillBean(JndiJdbcDataSourceBean bean, JndiJdbcReportDataSource dataSource)
protected void fillBean(OlapUnitBean bean, OlapUnit unit)
protected void fillBean(XmlaConnectionBean bean, XMLAConnection conn)
protected void fillBean(MondrianConnectionBean bean, MondrianConnection conn)
protected void fillBean(MondrianXmlaDefinitionBean bean, MondrianXMLADefinition xDef)
protected void fillBean(InputControlBean bean, InputControl ic)
protected void fillBean(DataTypeBean bean, DataType dt)
protected void fillBean(ListOfValuesBean bean, ListOfValues listOfValues)
protected void fillBean(QueryBean bean, Query query)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |