com.ibm.tivoli.maximo.report.birt.admin

Class ReportAdminService

java.lang.Object

psdi.server.AppService

com.ibm.tivoli.maximo.report.birt.admin.ReportAdminService

All Implemented Interfaces:

ReportAdminServiceRemote, java.rmi.Remote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers

public class ReportAdminService
extends AppService
implements ReportAdminServiceRemote

A class used for providing Report Admin features for BIRT reports used within MAXIMO.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_VIEWERURL

Fields inherited from interface com.ibm.tivoli.maximo.report.birt.admin.ReportAdminServiceRemote

OUTPUT_FORMAT_HTML, OUTPUT_FORMAT_PDF, OUTPUT_FORMAT_XLS, OUTPUT_FORMAT_XLS_SPUDSOFT, OUTPUT_FORMAT_XLSX

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
ReportAdminService(MXServer mxServer) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	addActiveThread(java.lang.String threadName, java.lang.String reportName, java.lang.String appName, java.lang.String userName, boolean scheduledJob) Adds active thread information to the list of actively running report threads.
void	cancelReportJob(long reportJobId) Cancels a report job identified by the reportJobId
void	cancelReportJobOnThisServer(long reportJobId) Cancels a report job identified by the reportJobId on this instance only
void	cleanupReportResources(ReportRunInfo reportRunInfo) Removes all the temporary files created as part of the prepareReportForRun method call.
static java.lang.String	createBROSUniqueTempFolder(java.lang.String parentFolderName)
void	createReportDesign(UserInfo userInfo, CreateReportInputInfo reportInputInfo) Creates a report based on the input provided.
void	createReportUsageLog(UserInfo userInfo, ReportUsageLogInfo usageLogInfo) Creates a report usage log entry based on the information provided.
byte[]	createResourcesZip(java.io.File[] files)
static java.lang.String	createUniqueTempFolder(java.lang.String parentFolderName)
void	destroy() If the Report Queue Manager Task is available, marks the task to shutdown and makes it available.
java.lang.String	exportLibraryImportInputInfo(UserInfo userInfo, java.lang.String reportName) Exports the information to be used as input to import the report library in XML format.
byte[]	exportReport(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) Exports the report design and all resources.
java.lang.String	exportReportImportInputInfo(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) Exports the information to be used as input to import the report in XML format.
byte[]	exportReportLibrary(UserInfo userInfo, java.lang.String reportName) Exports the report library design and all resources.
void	exportTransientQBRContent(java.lang.String brosId, MXSession session)
void	extractResourcesFromByteArray(java.io.ByteArrayInputStream resources, java.lang.String outputFolder)
java.lang.String	getDateFormat(UserInfo userInfo)
java.lang.String	getDateTimeFormat(UserInfo userInfo)
java.lang.String	getDateTimeFormat(UserInfo userInfo, java.lang.String objectName, java.lang.String attributeName)
java.lang.String	getDecimalFormat(UserInfo userInfo, int fractionDigits)
java.lang.String	getExportReportFolder(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) Returns the folder name to be used to export the report.
byte[]	getFileContent(java.lang.String fileName)
java.lang.String	getNumberFormat(UserInfo userInfo)
java.lang.String	getNumberFormat(UserInfo userInfo, java.lang.String objectName, java.lang.String attributeName)
MboRemote	getReport(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) Given the userInfo, reportName, and appName, return the report instance.
int	getReportEngineState() Returns the state of the report engine based on current activity and the max concurrent reports setting.
java.util.ArrayList<java.lang.String>	getReportLibraryNameList(UserInfo userInfo) Returns a list of the report library names.
java.util.TreeMap<java.lang.String,java.util.List>	getReportNameList(UserInfo userInfo) Returns list of report names.
java.util.TreeMap<java.lang.String,java.util.List>	getReportNameList(UserInfo userInfo, int reportType) Returns list of report names.
java.lang.String	getReportViewerURL() Returns the report viewer URL.
java.lang.String	getTimeFormat(UserInfo userInfo)
MboSetRemote	getTransientQBRParamsMboSet(java.lang.String brosId, MXSession session)
void	importReport(UserInfo userInfo, ReportImportInfo reportImportInfo, boolean fromUI) Imports the report information into appropriate tables in the database.
void	importReportLibrary(UserInfo userInfo, ReportImportInfo reportImportInfo) Imports the report library information into appropriate tables in the database.
void	init() Initializes the Report Queue Manager Task.
boolean	isAuthorizedToRunReport(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) Returns whether the report is authorized for run or not.
boolean	isOverloaded() Returns whether the report engine is overloaded or not (as set by the max concurrent reports setting).
boolean	isReportJobCancelled(long reportJobId) Returns true if the request report job is canceled, otherwise false.
ReportRunInfo	prepareReportDesignForRun(UserInfo userInfo, java.lang.String reportName, boolean extractAll) Prepares the report for run.
ReportRunInfo	prepareReportDesignForRun(UserInfo userInfo, java.lang.String reportName, boolean extractAll, boolean forExport) Prepares the report for run.
ReportRunInfo	prepareReportForRun(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) Prepares a report for run.
ReportRunInfo	prepareReportLibraryForExport(UserInfo userInfo, java.lang.String reportName) Prepares the report library for export.
void	removeActiveThread(java.lang.String threadName) Removes the active thread information from the list of actively running report threads.
void	removeBROSReport(java.lang.String brosId)
void	renewActiveThread(java.lang.String threadName) Renews the lease information on the active thread.
byte[]	runReport(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, ReportParameterData parameterData, java.lang.String outputFileName, java.lang.String outputFormat) Executes the report and returns the report output in the appropriate format.
byte[]	runReport(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, ReportParameterData parameterData, java.lang.String outputFileName, java.lang.String outputFormat, java.util.Map<java.lang.String,java.lang.Object> additionalInfoMap) Executes the report and returns the report output in the appropriate format.
byte[]	runReport(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, ReportParameterData parameterData, java.lang.String outputFileName, java.lang.String outputFormat, java.util.Map<java.lang.String,java.lang.Object> additionalInfoMap, boolean scheduled) Executes the report and returns the report output in the appropriate format.
byte[]	runReportInImmediateMode(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, ReportParameterData parameterData, java.lang.String outputFileName, java.lang.String outputFormat) Executes the report and returns the report output in the appropriate format.
byte[]	runReportInImmediateMode(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, ReportParameterData parameterData, java.lang.String outputFileName, java.lang.String outputFormat, java.util.Map<java.lang.String,java.lang.Object> additionalInfoMap) Executes the report and returns the report output in the appropriate format.
void	sendEmail(MXLogger logger, UserInfo userInfo, java.lang.String templateID, java.lang.String[] to, java.lang.String from, MboRemote report, TextReplacement replacer) Sends and email using the given Comm Template Id for the provided userInfo and scheduled report instance.
void	startBatchReportImport() Import all reports which are not already imported.
byte[]	updateReportDesign(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, boolean saveChanges) Updates the report design with all identified fixes.
byte[]	updateReportDesign(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, boolean saveChanges, java.lang.String updateType) Updates the report design with the identified fix, or all fixes if no update type is provided.

Methods inherited from class psdi.server.AppService

checkSecurity, configure, freeDBConnection, freeMboSet, getCriteria, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, initCriteriaList, isAppService, isRunning, isSingletonService, restart, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService, restart

Field Detail

PROPERTY_VIEWERURL

public static final java.lang.String PROPERTY_VIEWERURL

See Also:

Constant Field Values

Constructor Detail

ReportAdminService

public ReportAdminService(MXServer mxServer)
                   throws java.rmi.RemoteException

Constructor

Parameters:

mxServer -

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()

Initializes the Report Queue Manager Task.

Specified by:

init in interface Service

Overrides:

init in class AppService

See Also:

Service

startBatchReportImport

public void startBatchReportImport()
                            throws java.rmi.RemoteException

Import all reports which are not already imported. In MT these reports are imported using Master profile.

Specified by:

startBatchReportImport in interface ReportAdminServiceRemote

Throws:

java.rmi.RemoteException

destroy

public void destroy()

If the Report Queue Manager Task is available, marks the task to shutdown and makes it available.

Specified by:

destroy in interface Service

Overrides:

destroy in class AppService

See Also:

Service

updateReportDesign

public byte[] updateReportDesign(UserInfo userInfo,
                        java.lang.String reportName,
                        java.lang.String appName,
                        boolean saveChanges)
                          throws MXException,
                                 java.rmi.RemoteException

Updates the report design with all identified fixes. If specified, saves the update to the database. Returns the modified report design, which can be exported to the report source directory.

Specified by:

updateReportDesign in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - name of the report

appName - application name that the report belongs to

saveChanges - should the update design be saved to the reportdesign table

Returns:

byte[] the modified report design, null if the design was not modified.

Throws:

MXException

java.rmi.RemoteException

updateReportDesign

public byte[] updateReportDesign(UserInfo userInfo,
                        java.lang.String reportName,
                        java.lang.String appName,
                        boolean saveChanges,
                        java.lang.String updateType)
                          throws MXException,
                                 java.rmi.RemoteException

Updates the report design with the identified fix, or all fixes if no update type is provided. If specified, saves the update to the database. Returns the modified report design, which can be exported to the report source directory.

Specified by:

updateReportDesign in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - name of the report

appName - application name that the report belongs to

saveChanges - should the update design be saved to the reportdesign table

updateType - the specific update to be applied, or all updates if null

Returns:

byte[] the modified report design, null if the design was not modified.

Throws:

MXException

java.rmi.RemoteException

importReport

public void importReport(UserInfo userInfo,
                ReportImportInfo reportImportInfo,
                boolean fromUI)
                  throws MXException,
                         java.rmi.RemoteException

Imports the report information into appropriate tables in the database.

Specified by:

importReport in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportImportInfo - report import information to be used

fromUI - was this import initiated from the Report Administration application?

Throws:

MXException

java.rmi.RemoteException

importReportLibrary

public void importReportLibrary(UserInfo userInfo,
                       ReportImportInfo reportImportInfo)
                         throws MXException,
                                java.rmi.RemoteException

Imports the report library information into appropriate tables in the database.

Specified by:

importReportLibrary in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportImportInfo - report import information to be used

Throws:

MXException

java.rmi.RemoteException

prepareReportForRun

public ReportRunInfo prepareReportForRun(UserInfo userInfo,
                                java.lang.String reportName,
                                java.lang.String appName)
                                  throws MXException,
                                         java.rmi.RemoteException

Prepares a report for run. Exports the report from the database to a temporary file system. Also, exports all dependent report library information. NOTE: This is an internal method and should not be used by any client program. If this is used, then make sure to call the cleanupReportResources method appropriately to cleanup the temporary files.

Specified by:

prepareReportForRun in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - report name

appName - application name that the report belongs to

Returns:

ReportRunInfo report run information

Throws:

MXException

java.rmi.RemoteException

cleanupReportResources

public void cleanupReportResources(ReportRunInfo reportRunInfo)
                            throws MXException,
                                   java.rmi.RemoteException

Removes all the temporary files created as part of the prepareReportForRun method call.

Specified by:

cleanupReportResources in interface ReportAdminServiceRemote

Parameters:

reportRunInfo - report run information

Throws:

MXException

java.rmi.RemoteException

prepareReportLibraryForExport

public ReportRunInfo prepareReportLibraryForExport(UserInfo userInfo,
                                          java.lang.String reportName)
                                            throws MXException,
                                                   java.rmi.RemoteException

Prepares the report library for export. Extracts the report out from the database and prepares a copy of it in the file system.

Parameters:

userInfo -

reportName -

Returns:

Throws:

MXException

java.rmi.RemoteException

prepareReportDesignForRun

public ReportRunInfo prepareReportDesignForRun(UserInfo userInfo,
                                      java.lang.String reportName,
                                      boolean extractAll)
                                        throws MXException,
                                               java.rmi.RemoteException

Prepares the report for run. Extracts the report out from the database and prepares a copy of it in the file system.

Parameters:

userInfo -

reportName -

extractAll -

Returns:

Throws:

MXException

java.rmi.RemoteException

prepareReportDesignForRun

public ReportRunInfo prepareReportDesignForRun(UserInfo userInfo,
                                      java.lang.String reportName,
                                      boolean extractAll,
                                      boolean forExport)
                                        throws MXException,
                                               java.rmi.RemoteException

Prepares the report for run. Extracts the report out from the database and prepares a copy of it in the file system.

Parameters:

userInfo -

reportName -

extractAll -

forExport - true if the report is being exported, false if it is being executed

Returns:

Throws:

MXException

java.rmi.RemoteException

createUniqueTempFolder

public static java.lang.String createUniqueTempFolder(java.lang.String parentFolderName)

extractResourcesFromByteArray

public void extractResourcesFromByteArray(java.io.ByteArrayInputStream resources,
                                 java.lang.String outputFolder)
                                   throws java.io.IOException

Throws:

java.io.IOException

exportReport

public byte[] exportReport(UserInfo userInfo,
                  java.lang.String reportName,
                  java.lang.String appName)
                    throws MXException,
                           java.rmi.RemoteException

Exports the report design and all resources.

Specified by:

exportReport in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - report name to export

appName - application name that the report belongs to

Returns:

byte[] a zip output of the report design and all associated resources.

Throws:

MXException

java.rmi.RemoteException

getExportReportFolder

public java.lang.String getExportReportFolder(UserInfo userInfo,
                                     java.lang.String reportName,
                                     java.lang.String appName)
                                       throws MXException,
                                              java.rmi.RemoteException

Returns the folder name to be used to export the report.

Specified by:

getExportReportFolder in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - report name

appName - application name that the report belongs to

Returns:

String the folder name to be used to export the report.

Throws:

MXException

java.rmi.RemoteException

exportReportLibrary

public byte[] exportReportLibrary(UserInfo userInfo,
                         java.lang.String reportName)
                           throws MXException,
                                  java.rmi.RemoteException

Exports the report library design and all resources.

Specified by:

exportReportLibrary in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - report library name to export

Returns:

byte[] a zip output of the report library design and all associated resources.

Throws:

MXException

java.rmi.RemoteException

getReportLibraryNameList

public java.util.ArrayList<java.lang.String> getReportLibraryNameList(UserInfo userInfo)
                                                               throws MXException,
                                                                      java.rmi.RemoteException

Returns a list of the report library names. (used for the exporting all library files).

Specified by:

getReportLibraryNameList in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

Returns:

ArrayList a list of the report library names

Throws:

MXException

java.rmi.RemoteException

getReportNameList

public java.util.TreeMap<java.lang.String,java.util.List> getReportNameList(UserInfo userInfo)
                                                                     throws MXException,
                                                                            java.rmi.RemoteException

Returns list of report names. (used for the exporting all report files).

Specified by:

getReportNameList in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

Returns:

ArrayList a list of the report names

Throws:

MXException

java.rmi.RemoteException

getReportNameList

public java.util.TreeMap<java.lang.String,java.util.List> getReportNameList(UserInfo userInfo,
                                                                   int reportType)
                                                                     throws MXException,
                                                                            java.rmi.RemoteException

Returns list of report names. (used for the exporting report files of a certain type).

Specified by:

getReportNameList in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportType - the report type: REPORTTYPE_REPORT, REPORTTYPE_QBR, or REPORTTYPE_REPORT_AND_QBR

Returns:

ArrayList a list of the report names

Throws:

MXException

java.rmi.RemoteException

getDateFormat

public java.lang.String getDateFormat(UserInfo userInfo)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getTimeFormat

public java.lang.String getTimeFormat(UserInfo userInfo)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getDateTimeFormat

public java.lang.String getDateTimeFormat(UserInfo userInfo)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDateTimeFormat

public java.lang.String getDateTimeFormat(UserInfo userInfo,
                                 java.lang.String objectName,
                                 java.lang.String attributeName)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getNumberFormat

public java.lang.String getNumberFormat(UserInfo userInfo)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getDecimalFormat

public java.lang.String getDecimalFormat(UserInfo userInfo,
                                int fractionDigits)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getNumberFormat

public java.lang.String getNumberFormat(UserInfo userInfo,
                               java.lang.String objectName,
                               java.lang.String attributeName)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

runReportInImmediateMode

public byte[] runReportInImmediateMode(UserInfo userInfo,
                              java.lang.String reportName,
                              java.lang.String appName,
                              ReportParameterData parameterData,
                              java.lang.String outputFileName,
                              java.lang.String outputFormat)
                                throws MXException,
                                       java.rmi.RemoteException

Executes the report and returns the report output in the appropriate format. If the output format requested is PDF, then returns the output as PDF. If the output format requested is HTML, then returns the output in ZIP format as multiple files are involved.

Specified by:

runReportInImmediateMode in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - report name

appName - application name that the report belongs to

parameterData - parameter data to be used for the report

outputFileName - output file name

outputFormat - output format

Returns:

byte[] report output. If the output format requested is PDF, then returns the output as PDF. If the output format requested is HTML, then returns the output in ZIP format as multiple files are involved.

Throws:

MXException

java.rmi.RemoteException

runReportInImmediateMode

public byte[] runReportInImmediateMode(UserInfo userInfo,
                              java.lang.String reportName,
                              java.lang.String appName,
                              ReportParameterData parameterData,
                              java.lang.String outputFileName,
                              java.lang.String outputFormat,
                              java.util.Map<java.lang.String,java.lang.Object> additionalInfoMap)
                                throws MXException,
                                       java.rmi.RemoteException

Executes the report and returns the report output in the appropriate format. If the output format requested is PDF, then returns the output as PDF. If the output format requested is HTML, then returns the output in ZIP format as multiple files are involved.

Specified by:

runReportInImmediateMode in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - report name

appName - application name that the report belongs to

parameterData - parameter data to be used for the report

outputFileName - output file name

outputFormat - output format

additionalInfoMap - additional information to be passed to the report.

Returns:

byte[] report output. If the output format requested is PDF, then returns the output as PDF. If the output format requested is HTML, then returns the output in ZIP format as multiple files are involved.

Throws:

MXException

java.rmi.RemoteException

runReport

public byte[] runReport(UserInfo userInfo,
               java.lang.String reportName,
               java.lang.String appName,
               ReportParameterData parameterData,
               java.lang.String outputFileName,
               java.lang.String outputFormat)
                 throws MXException,
                        java.rmi.RemoteException

Executes the report and returns the report output in the appropriate format. If the output format requested is PDF, then returns the output as PDF. If the output format requested is HTML, then returns the output in ZIP format as multiple files are involved.

Specified by:

runReport in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - report name

appName - application name that the report belongs to

parameterData - parameter data to be used for the report

outputFileName - output file name

outputFormat - output format (OUTPUT_FORMAT_PDF or OUTPUT_FORMAT_HTML)

Returns:

byte[] report output. If the output format requested is PDF, then returns the output as PDF. If the output format requested is HTML, then returns the output in ZIP format as multiple files are involved.

Throws:

MXException

java.rmi.RemoteException

runReport

public byte[] runReport(UserInfo userInfo,
               java.lang.String reportName,
               java.lang.String appName,
               ReportParameterData parameterData,
               java.lang.String outputFileName,
               java.lang.String outputFormat,
               java.util.Map<java.lang.String,java.lang.Object> additionalInfoMap)
                 throws MXException,
                        java.rmi.RemoteException

Executes the report and returns the report output in the appropriate format. If the output format requested is PDF, then returns the output as PDF. If the output format requested is HTML, then returns the output in ZIP format as multiple files are involved.

Specified by:

runReport in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - report name

appName - application name that the report belongs to

parameterData - parameter data to be used for the report

outputFileName - output file name

outputFormat - output format (OUTPUT_FORMAT_PDF or OUTPUT_FORMAT_HTML)

additionalInfoMap - additional information to be passed to the report.

Returns:

byte[] report output. If the output format requested is PDF, then returns the output as PDF. If the output format requested is HTML, then returns the output in ZIP format as multiple files are involved.

Throws:

MXException

java.rmi.RemoteException

runReport

public byte[] runReport(UserInfo userInfo,
               java.lang.String reportName,
               java.lang.String appName,
               ReportParameterData parameterData,
               java.lang.String outputFileName,
               java.lang.String outputFormat,
               java.util.Map<java.lang.String,java.lang.Object> additionalInfoMap,
               boolean scheduled)
                 throws MXException,
                        java.rmi.RemoteException

Executes the report and returns the report output in the appropriate format. If the output format requested is PDF, then returns the output as PDF. If the output format requested is HTML, then returns the output in ZIP format as multiple files are involved.

Parameters:

userInfo - user information

reportName - report name

appName - application name that the report belongs to

parameterData - parameter data to be used for the report

outputFileName - output file name

outputFormat - output format (OUTPUT_FORMAT_PDF or OUTPUT_FORMAT_HTML)

additionalInfoMap - additional information to be passed to the report.

Returns:

byte[] report output. If the output format requested is PDF, then returns the output as PDF. If the output format requested is HTML, then returns the output in ZIP format as multiple files are involved.

Throws:

MXException

java.rmi.RemoteException

createReportUsageLog

public void createReportUsageLog(UserInfo userInfo,
                        ReportUsageLogInfo usageLogInfo)
                          throws MXException,
                                 java.rmi.RemoteException

Creates a report usage log entry based on the information provided.

Specified by:

createReportUsageLog in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

usageLogInfo - report usage log information

Throws:

MXException

java.rmi.RemoteException

isOverloaded

public boolean isOverloaded()
                     throws MXException,
                            java.rmi.RemoteException

Returns whether the report engine is overloaded or not (as set by the max concurrent reports setting).

Specified by:

isOverloaded in interface ReportAdminServiceRemote

Returns:

boolean true, if the report engine is overloaded executing reports (as set by the max concurrent reports setting), otherwise false.

Throws:

MXException

java.rmi.RemoteException

getReportEngineState

public int getReportEngineState()
                         throws MXException,
                                java.rmi.RemoteException

Returns the state of the report engine based on current activity and the max concurrent reports setting.

Specified by:

getReportEngineState in interface ReportAdminServiceRemote

Returns:

THREAD_AVAILABLE There is a thread available to process the report

Throws:

MXException

java.rmi.RemoteException

addActiveThread

public java.lang.Long addActiveThread(java.lang.String threadName,
                             java.lang.String reportName,
                             java.lang.String appName,
                             java.lang.String userName,
                             boolean scheduledJob)
                               throws MXException,
                                      java.rmi.RemoteException

Adds active thread information to the list of actively running report threads.

Specified by:

addActiveThread in interface ReportAdminServiceRemote

Parameters:

threadName - name of the thread

reportName - report name being executed by the thread

appName - application name that the report belongs to

userName - user name (context in which the report is executed)

scheduledJob - a flag to indicate whether this is a scheduled job or not.

Throws:

MXException

java.rmi.RemoteException

removeActiveThread

public void removeActiveThread(java.lang.String threadName)
                        throws MXException,
                               java.rmi.RemoteException

Removes the active thread information from the list of actively running report threads.

Specified by:

removeActiveThread in interface ReportAdminServiceRemote

Parameters:

threadName - name of the thread.

Throws:

MXException

java.rmi.RemoteException

renewActiveThread

public void renewActiveThread(java.lang.String threadName)
                       throws MXException,
                              java.rmi.RemoteException

Renews the lease information on the active thread.

Specified by:

renewActiveThread in interface ReportAdminServiceRemote

Parameters:

threadName - name of the thread

Throws:

MXException

java.rmi.RemoteException

exportReportImportInputInfo

public java.lang.String exportReportImportInputInfo(UserInfo userInfo,
                                           java.lang.String reportName,
                                           java.lang.String appName)
                                             throws MXException,
                                                    java.rmi.RemoteException

Exports the information to be used as input to import the report in XML format.

Specified by:

exportReportImportInputInfo in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - report name

appName - application name that the report belongs to

Returns:

String the information to be used as input to import the report in XML format.

Throws:

MXException

java.rmi.RemoteException

exportLibraryImportInputInfo

public java.lang.String exportLibraryImportInputInfo(UserInfo userInfo,
                                            java.lang.String reportName)
                                              throws MXException,
                                                     java.rmi.RemoteException

Exports the information to be used as input to import the report library in XML format.

Specified by:

exportLibraryImportInputInfo in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - report name

Returns:

String the information to be used as input to import the report library in XML format.

Throws:

MXException

java.rmi.RemoteException

createReportDesign

public void createReportDesign(UserInfo userInfo,
                      CreateReportInputInfo reportInputInfo)
                        throws MXException,
                               java.rmi.RemoteException

Creates a report based on the input provided. Used by QBR/Create Report functionality. A report design consists of one or more CreateListReportInputInfo list reports. If there is only one in the report, the style is List. If the report includes more than one CreateListReportInputInfo, the style is Detail and the first one in the list is the master or parent report, with the remaining being detail reports.

Specified by:

createReportDesign in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportInputInfo - input to create the report

Throws:

MXException

java.rmi.RemoteException

getFileContent

public byte[] getFileContent(java.lang.String fileName)
                      throws java.io.IOException

Throws:

java.io.IOException

createResourcesZip

public byte[] createResourcesZip(java.io.File[] files)
                          throws java.lang.Exception

Throws:

java.lang.Exception

isAuthorizedToRunReport

public boolean isAuthorizedToRunReport(UserInfo userInfo,
                              java.lang.String reportName,
                              java.lang.String appName)
                                throws MXException,
                                       java.rmi.RemoteException

Returns whether the report is authorized for run or not. NOTE: This code adds some additional logic to authorize temporary reports that are created via the createListReport API that are not saved/imported to the database.

Specified by:

isAuthorizedToRunReport in interface ReportAdminServiceRemote

Parameters:

userInfo - user information

reportName - name of the report

appName - application for which the report belongs

Throws:

MXException

java.rmi.RemoteException

getReportViewerURL

public java.lang.String getReportViewerURL()
                                    throws MXException,
                                           java.rmi.RemoteException

Returns the report viewer URL. This is used for cases where a cluster or a dedicated report server is setup to run the immediate run reports from the browser. Returns null, if the property mxe.report.birt.viewerurl is not defined or has a null value.

Specified by:

getReportViewerURL in interface ReportAdminServiceRemote

Returns:

Throws:

MXException

java.rmi.RemoteException

cancelReportJob

public void cancelReportJob(long reportJobId)
                     throws MXException,
                            java.rmi.RemoteException

Cancels a report job identified by the reportJobId

Specified by:

cancelReportJob in interface ReportAdminServiceRemote

Parameters:

reportJobId -

Throws:

MXException

java.rmi.RemoteException

cancelReportJobOnThisServer

public void cancelReportJobOnThisServer(long reportJobId)
                                 throws MXException,
                                        java.rmi.RemoteException

Cancels a report job identified by the reportJobId on this instance only

Specified by:

cancelReportJobOnThisServer in interface ReportAdminServiceRemote

Parameters:

reportJobId -

Throws:

MXException

java.rmi.RemoteException

isReportJobCancelled

public boolean isReportJobCancelled(long reportJobId)
                             throws MXException,
                                    java.rmi.RemoteException

Returns true if the request report job is canceled, otherwise false.

Specified by:

isReportJobCancelled in interface ReportAdminServiceRemote

Parameters:

reportJobId -

Returns:

Throws:

MXException

java.rmi.RemoteException

exportTransientQBRContent

public void exportTransientQBRContent(java.lang.String brosId,
                             MXSession session)

getTransientQBRParamsMboSet

public MboSetRemote getTransientQBRParamsMboSet(java.lang.String brosId,
                                       MXSession session)

removeBROSReport

public void removeBROSReport(java.lang.String brosId)
                      throws java.rmi.RemoteException,
                             MXException

Throws:

java.rmi.RemoteException

MXException

createBROSUniqueTempFolder

public static java.lang.String createBROSUniqueTempFolder(java.lang.String parentFolderName)

sendEmail

public void sendEmail(MXLogger logger,
             UserInfo userInfo,
             java.lang.String templateID,
             java.lang.String[] to,
             java.lang.String from,
             MboRemote report,
             TextReplacement replacer)
               throws java.rmi.RemoteException,
                      MXException

Sends and email using the given Comm Template Id for the provided userInfo and scheduled report instance. Optionally a TextReplacements can be pass that can replace any additional placeholders with replacement values in the message and subject.

Specified by:

sendEmail in interface ReportAdminServiceRemote

Parameters:

logger - logger to use for logging, can be null.

userInfo -

templateID - Comm Template Id

to -

from -

report - Scheduled Report Instance

replacer - Optional TextReplacement instance

Throws:

java.rmi.RemoteException

MXException

getReport

public MboRemote getReport(UserInfo userInfo,
                  java.lang.String reportName,
                  java.lang.String appName)
                    throws java.rmi.RemoteException,
                           MXException

Given the userInfo, reportName, and appName, return the report instance.

Specified by:

getReport in interface ReportAdminServiceRemote

Parameters:

userInfo -

reportName -

appName -

Returns:

Throws:

java.rmi.RemoteException

MXException