com.hof.mi.web.service

Class ReportServiceClient

java.lang.Object

com.hof.mi.web.service.ReportServiceClient

All Implemented Interfaces:

java.io.Serializable

public class ReportServiceClient
extends java.lang.Object
implements java.io.Serializable

ReportServiceClient is an instance of a Yellowfin web services connection. This class retains the webservices session information for connecting with a Yellowfin Reporting Webservice.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	clientReferenceId
protected java.lang.Integer	errorCode
protected boolean	internal
static boolean	logging
protected java.lang.String[]	messages
protected java.lang.String	password
protected boolean	secure
protected java.lang.String	sessionId
protected java.lang.String	username

Constructor Summary

Constructors

Constructor and Description
ReportServiceClient() Creates a non-webservices session-based connection to Yellowfin.
ReportServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String serviceURL, boolean secure, boolean internal, java.lang.String clientReferenceId) Creates a webservices session-based connection to Yellowfin.
ReportServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String username, java.lang.String password) Creates a webservices session-based connection to Yellowfin.
ReportServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String username, java.lang.String password, boolean secure) Creates a webservices session-based connection to Yellowfin.
ReportServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String username, java.lang.String password, java.lang.String serviceURL) Creates a webservices session-based connection to Yellowfin.
ReportServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String username, java.lang.String password, java.lang.String serviceURL, boolean secure, boolean internal) Creates a webservices session-based connection to Yellowfin.
ReportServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String username, java.lang.String password, java.lang.String serviceURL, boolean secure, boolean internal, java.lang.String clientReferenceId) Creates a webservices session-based connection to Yellowfin.
ReportServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String username, java.lang.String password, java.lang.String serviceURL, boolean secure, boolean internal, java.lang.String clientReferenceId, boolean test) Creates a webservices session-based connection to Yellowfin.
ReportServiceClient(java.lang.String username, java.lang.String password) Creates a non-webservices session-based connection to Yellowfin.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer[]	applyDashboardFilters(java.lang.Integer tabId, DashboardFilter[] filters)
java.lang.Integer[]	applyDashboardFilters(java.lang.Integer tabId, DashboardFilter[] filters, java.lang.String reportUserId, java.lang.String reportUserPassword, java.lang.String reportUserClientReferenceId)
protected ReportServiceResponse	doWebServicesRequest(ReportServiceRequest rsr) Perform a Webservices Request (Used Internally and by methods in i4Report)
java.lang.String	getClientReferenceId() Returns the client reference id used in web service calls.
ReportFilter[]	getDashboardReportFilterValues(java.lang.Integer tabId, java.lang.Integer reportId)
ReportFilter[]	getDashboardReportFilterValues(java.lang.Integer tabId, java.lang.Integer reportId, java.lang.String reportUserId, java.lang.String reportUserPassword, java.lang.String reportUserClientReferenceId)
boolean	getDrillAnywhereMenu(java.lang.Integer reportId, java.lang.Integer fieldId, java.lang.String cellValue, java.lang.String uniqueValueName) Populate the ReportServiceResponse.drillAnywhereCategories and ReportServiceResponse.drillAnywhereTargets for the applicable drill-anywhere enabled field.
java.lang.Integer	getErrorCode()
java.lang.String[]	getMessages() Get Last set of server messages.
int	getPort() Get Service TCPIP Port
KPI	getReportKPIs(java.lang.Integer reportId)
ReportServiceResponse	getRs()
ReportServiceRequest	getRsr()
java.lang.String	getServiceURL() Get Service URL
java.lang.String	getUsername() Get Service User
java.lang.String	getWebServicesHost() Get Service Host Name
DashboardDefinition	loadDashboardParentTab(java.lang.Integer tabId, java.lang.String reportUserId, java.lang.String reportUserPassword, java.lang.String reportUserClientReferenceId)
DashboardDefinition	loadDashboardTab(java.lang.Integer tabId)
DashboardDefinition	loadDashboardTab(java.lang.Integer tabId, java.lang.String reportUserId, java.lang.String reportUserPassword, java.lang.String reportUserClientReferenceId)
i4Report	loadDeletedReportForUser(java.lang.Integer reportId, java.lang.String reportUserId, java.lang.String reportUserPassword, java.lang.String reportUserClientReferenceId) Loads a deleted i4Report using a Report Id.
i4Report	LoadReport(java.lang.Integer reportId) Loads a new i4Report using a Report Id.
i4Report	LoadReport(java.lang.String ObjectName) Loads a new i4Report using the Execution Object Name specified from within the Yellowfin Frontend.
i4Report	loadReportForUser(java.lang.Integer reportId, java.lang.String reportUserId, java.lang.String reportUserPassword, java.lang.String reportUserClientReferenceId) Loads a new i4Report using a Report Id.
i4Report	loadReportForUser(java.lang.String objectName, java.lang.String reportUserId, java.lang.String reportUserPassword, java.lang.String reportUserClientReferenceId) Loads a new i4Report using the Execution Object Name specified from within the Yellowfin Frontend.
StoryboardDescriptor[]	loadStoryboardDescriptors()
StoryboardDescriptor[]	loadStoryboardDescriptors(java.lang.String reportUserId, java.lang.String reportUserPassword, java.lang.String reportUserClientReferenceId)
i4Report	runDashboardReport(java.lang.Integer tabId, java.lang.Integer reportId, java.util.HashMap storage, java.lang.String reportTypeCode, ReportServiceRequest rsr)
i4Report	runDashboardReport(java.lang.Integer tabId, java.lang.Integer reportId, java.util.HashMap storage, java.lang.String reportTypeCode, java.lang.String imageURL, java.lang.String linkURL)
i4Report	runDashboardReport(java.lang.Integer tabId, java.lang.Integer reportId, java.util.HashMap storage, java.lang.String reportUserId, java.lang.String reportUserPassword, java.lang.String reportUserClientReferenceId, java.lang.String reportTypeCode, ReportServiceRequest rsr)
i4Report	runDashboardReport(java.lang.Integer tabId, java.lang.Integer reportId, java.util.HashMap storage, java.lang.String reportUserId, java.lang.String reportUserPassword, java.lang.String reportUserClientReferenceId, java.lang.String reportTypeCode, java.lang.String imageURL, java.lang.String linkURL)
void	setClientReferenceId(java.lang.String clientReferenceId) Sets the client reference id used in web service calls.
void	setErrorCode(java.lang.Integer errorCode)
void	setPassword(java.lang.String Password)
void	setRs(ReportServiceResponse rs)
void	setRsr(ReportServiceRequest rsr)
void	setUsername(java.lang.String Username)
boolean	updateCommentStatus(java.lang.Integer commentId, java.lang.String statusCode)

Methods inherited from class java.lang.Object

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

Field Detail

logging

public static final boolean logging

See Also:

Constant Field Values

username

protected java.lang.String username

password

protected java.lang.String password

sessionId

protected java.lang.String sessionId

messages

protected java.lang.String[] messages

secure

protected boolean secure

internal

protected boolean internal

clientReferenceId

protected java.lang.String clientReferenceId

errorCode

protected java.lang.Integer errorCode

Constructor Detail

ReportServiceClient

public ReportServiceClient()
                    throws WebserviceException

Creates a non-webservices session-based connection to Yellowfin. You only need to supply a user for the administration. This connection will only work when Yellowfin is running in the same JVM.

Throws:

WebserviceException

ReportServiceClient

public ReportServiceClient(java.lang.String username,
                           java.lang.String password)
                    throws WebserviceException

Creates a non-webservices session-based connection to Yellowfin. You only need to supply a user for the administration. This connection will only work when Yellowfin is running in the same JVM.

Parameters:

username - Web Service UserName

password - Web Service User Password

Throws:

WebserviceException

ReportServiceClient

public ReportServiceClient(java.lang.String webServiceHost,
                           int webServicePort,
                           java.lang.String username,
                           java.lang.String password)
                    throws WebserviceException

Creates a webservices session-based connection to Yellowfin. This will use the default path to the Yellowfin WebService. You only need one webservices connection for multiple reports from the one service

Parameters:

webServiceHost - Web Service Host

webServicePort - Web Service Port

username - Web Service UserName

password - Web Service User Password

Throws:

WebserviceException

ReportServiceClient

public ReportServiceClient(java.lang.String webServiceHost,
                           int webServicePort,
                           java.lang.String username,
                           java.lang.String password,
                           boolean secure)
                    throws WebserviceException

Creates a webservices session-based connection to Yellowfin. This will use the default path to the Yellowfin WebService. You only need one webservices connection for multiple reports from the one service

Parameters:

webServiceHost - Web Service Host

webServicePort - Web Service Port

username - Web Service UserName

password - Web Service User Password

secure - whether or not to make an SSL connection

Throws:

WebserviceException

ReportServiceClient

public ReportServiceClient(java.lang.String webServiceHost,
                           int webServicePort,
                           java.lang.String username,
                           java.lang.String password,
                           java.lang.String serviceURL)
                    throws WebserviceException

Creates a webservices session-based connection to Yellowfin. You only need one webservices connection for multiple reports from the one service

Parameters:

webServiceHost - Web Service Host

webServicePort - Web Service Port

username - Web Service UserName

password - Web Service User Password

serviceURL - Alternate Web Service path

Throws:

WebserviceException

ReportServiceClient

public ReportServiceClient(java.lang.String webServiceHost,
                           int webServicePort,
                           java.lang.String username,
                           java.lang.String password,
                           java.lang.String serviceURL,
                           boolean secure,
                           boolean internal)
                    throws WebserviceException

Creates a webservices session-based connection to Yellowfin. You only need one webservices connection for multiple reports from the one service

Parameters:

webServiceHost - Web Service Host

webServicePort - Web Service Port

username - Web Service UserName

password - Web Service User Password

serviceURL - Alternate Web Service path

secure - whether or not to make an SSL connection

internal - connect to Yellowfin within this JVM (not using web services)

Throws:

WebserviceException

ReportServiceClient

public ReportServiceClient(java.lang.String webServiceHost,
                           int webServicePort,
                           java.lang.String serviceURL,
                           boolean secure,
                           boolean internal,
                           java.lang.String clientReferenceId)
                    throws WebserviceException

Creates a webservices session-based connection to Yellowfin. You only need one webservices connection for multiple reports from the one service This constructor excludes username and password for user when using the unsecure webservice option.

Parameters:

webServiceHost - Web Service Host

webServicePort - Web Service Port

serviceURL - Alternate Web Service path

secure - whether or not to make an SSL connection

internal - connect to Yellowfin within this JVM (not using web services)

clientReferenceId - the Client Reference Id used to connect this user to Yellowfin

Throws:

WebserviceException

ReportServiceClient

public ReportServiceClient(java.lang.String webServiceHost,
                           int webServicePort,
                           java.lang.String username,
                           java.lang.String password,
                           java.lang.String serviceURL,
                           boolean secure,
                           boolean internal,
                           java.lang.String clientReferenceId)
                    throws WebserviceException

Creates a webservices session-based connection to Yellowfin. You only need one webservices connection for multiple reports from the one service

Parameters:

webServiceHost - Web Service Host

webServicePort - Web Service Port

username - Web Service UserName

password - Web Service User Password

serviceURL - Alternate Web Service path

secure - whether or not to make an SSL connection

internal - connect to Yellowfin within this JVM (not using web services)

clientReferenceId - the Client Reference Id used to connect this user to Yellowfin

Throws:

WebserviceException

ReportServiceClient

public ReportServiceClient(java.lang.String webServiceHost,
                           int webServicePort,
                           java.lang.String username,
                           java.lang.String password,
                           java.lang.String serviceURL,
                           boolean secure,
                           boolean internal,
                           java.lang.String clientReferenceId,
                           boolean test)
                    throws WebserviceException

Creates a webservices session-based connection to Yellowfin. You only need one webservices connection for multiple reports from the one service

Parameters:

webServiceHost - Web Service Host

webServicePort - Web Service Port

username - Web Service UserName

password - Web Service User Password

serviceURL - Alternate Web Service path

secure - whether or not to make an SSL connection

internal - connect to Yellowfin within this JVM (not using web services)

clientReferenceId - the Client Reference Id used to connect this user to Yellowfin

test - whether or not to test the connection to the web service host

Throws:

WebserviceException

Method Detail

LoadReport

public i4Report LoadReport(java.lang.String ObjectName)

Loads a new i4Report using the Execution Object Name specified from within the Yellowfin Frontend. The user used to load and run the report is the web service user, specified by the username, password and client reference id. If the client reference id is set, the report must belong to that client.

Parameters:

ObjectName - report execution object name

Returns:

new i4Report or null on error

LoadReport

public i4Report LoadReport(java.lang.Integer reportId)

Loads a new i4Report using a Report Id. The user used to load and run the report is the web service user, specified by the username, password and client reference id. If the client reference id is set, the report must belong to that client.

Parameters:

reportId - the report id of the report to load

Returns:

new i4Report or null on error

loadReportForUser

public i4Report loadReportForUser(java.lang.String objectName,
                                  java.lang.String reportUserId,
                                  java.lang.String reportUserPassword,
                                  java.lang.String reportUserClientReferenceId)

Loads a new i4Report using the Execution Object Name specified from within the Yellowfin Frontend. The user specified by the user parameters is used to load and run the report. If the reportUserId is null, the web service user specified by the username, password and client reference id is used to load and run the report (equivalent to calling LoadReport(String)).

Parameters:

objectName - the report execution object name

reportUserId - the userId used to load and run the report

reportUserPassword - the password of the user used to load and run the report

reportUserClientReferenceId - the reference id of the client organisation used to authenticate the report user and load the report

Returns:

new i4Report or null on error

loadReportForUser

public i4Report loadReportForUser(java.lang.Integer reportId,
                                  java.lang.String reportUserId,
                                  java.lang.String reportUserPassword,
                                  java.lang.String reportUserClientReferenceId)

Loads a new i4Report using a Report Id. The user specified by the user parameters is used to load and run the report. If the reportUserId is null, the web service user specified by the username, password and client reference id is used to load and run the report (equivalent to calling LoadReport(String)).

Parameters:

reportId - the report id of the report to load

reportUserId - the userId used to load and run the report

reportUserPassword - the password of the user used to load and run the report

reportUserClientReferenceId - the reference id of the client organisation used to authenticate the report user and load the report

Returns:

new i4Report or null on error

loadDeletedReportForUser

public i4Report loadDeletedReportForUser(java.lang.Integer reportId,
                                         java.lang.String reportUserId,
                                         java.lang.String reportUserPassword,
                                         java.lang.String reportUserClientReferenceId)

Loads a deleted i4Report using a Report Id. The user specified by the user parameters is used to load and run the report. If the reportUserId is null, the web service user specified by the username, password and client reference id is used to load and run the report (equivalent to calling LoadReport(String)).

Parameters:

reportId - the report id of the report to load

reportUserId - the userId used to load and run the report

reportUserPassword - the password of the user used to load and run the report

reportUserClientReferenceId - the reference id of the client organisation used to authenticate the report user and load the report

Returns:

new i4Report or null on error

loadDashboardTab

public DashboardDefinition loadDashboardTab(java.lang.Integer tabId)

loadDashboardTab

public DashboardDefinition loadDashboardTab(java.lang.Integer tabId,
                                            java.lang.String reportUserId,
                                            java.lang.String reportUserPassword,
                                            java.lang.String reportUserClientReferenceId)

loadDashboardParentTab

public DashboardDefinition loadDashboardParentTab(java.lang.Integer tabId,
                                                  java.lang.String reportUserId,
                                                  java.lang.String reportUserPassword,
                                                  java.lang.String reportUserClientReferenceId)

loadStoryboardDescriptors

public StoryboardDescriptor[] loadStoryboardDescriptors()

loadStoryboardDescriptors

public StoryboardDescriptor[] loadStoryboardDescriptors(java.lang.String reportUserId,
                                                        java.lang.String reportUserPassword,
                                                        java.lang.String reportUserClientReferenceId)

applyDashboardFilters

public java.lang.Integer[] applyDashboardFilters(java.lang.Integer tabId,
                                                 DashboardFilter[] filters)

applyDashboardFilters

public java.lang.Integer[] applyDashboardFilters(java.lang.Integer tabId,
                                                 DashboardFilter[] filters,
                                                 java.lang.String reportUserId,
                                                 java.lang.String reportUserPassword,
                                                 java.lang.String reportUserClientReferenceId)

getReportKPIs

public KPI getReportKPIs(java.lang.Integer reportId)

runDashboardReport

public i4Report runDashboardReport(java.lang.Integer tabId,
                                   java.lang.Integer reportId,
                                   java.util.HashMap storage,
                                   java.lang.String reportTypeCode,
                                   java.lang.String imageURL,
                                   java.lang.String linkURL)

runDashboardReport

public i4Report runDashboardReport(java.lang.Integer tabId,
                                   java.lang.Integer reportId,
                                   java.util.HashMap storage,
                                   java.lang.String reportTypeCode,
                                   ReportServiceRequest rsr)

runDashboardReport

public i4Report runDashboardReport(java.lang.Integer tabId,
                                   java.lang.Integer reportId,
                                   java.util.HashMap storage,
                                   java.lang.String reportUserId,
                                   java.lang.String reportUserPassword,
                                   java.lang.String reportUserClientReferenceId,
                                   java.lang.String reportTypeCode,
                                   java.lang.String imageURL,
                                   java.lang.String linkURL)

runDashboardReport

public i4Report runDashboardReport(java.lang.Integer tabId,
                                   java.lang.Integer reportId,
                                   java.util.HashMap storage,
                                   java.lang.String reportUserId,
                                   java.lang.String reportUserPassword,
                                   java.lang.String reportUserClientReferenceId,
                                   java.lang.String reportTypeCode,
                                   ReportServiceRequest rsr)

updateCommentStatus

public boolean updateCommentStatus(java.lang.Integer commentId,
                                   java.lang.String statusCode)

getDashboardReportFilterValues

public ReportFilter[] getDashboardReportFilterValues(java.lang.Integer tabId,
                                                     java.lang.Integer reportId)

getDashboardReportFilterValues

public ReportFilter[] getDashboardReportFilterValues(java.lang.Integer tabId,
                                                     java.lang.Integer reportId,
                                                     java.lang.String reportUserId,
                                                     java.lang.String reportUserPassword,
                                                     java.lang.String reportUserClientReferenceId)

getDrillAnywhereMenu

public boolean getDrillAnywhereMenu(java.lang.Integer reportId,
                                    java.lang.Integer fieldId,
                                    java.lang.String cellValue,
                                    java.lang.String uniqueValueName)

Populate the ReportServiceResponse.drillAnywhereCategories and ReportServiceResponse.drillAnywhereTargets for the applicable drill-anywhere enabled field.

Parameters:

fieldId - - Drill-anywhere enabled field

cellValue - - Drill-anywhere field value

Returns:

doWebServicesRequest

protected ReportServiceResponse doWebServicesRequest(ReportServiceRequest rsr)
                                              throws WebserviceException

Perform a Webservices Request (Used Internally and by methods in i4Report)

Parameters:

Report - Service Request

Returns:

Web Services Response

Throws:

WebserviceException

getServiceURL

public java.lang.String getServiceURL()

Get Service URL

Returns:

URL

getPort

public int getPort()

Get Service TCPIP Port

Returns:

Port

getUsername

public java.lang.String getUsername()

Get Service User

Returns:

User Name

setUsername

public void setUsername(java.lang.String Username)

setPassword

public void setPassword(java.lang.String Password)

getWebServicesHost

public java.lang.String getWebServicesHost()

Get Service Host Name

Returns:

Host Name

getMessages

public java.lang.String[] getMessages()

Get Last set of server messages.

Returns:

Array of messages

getRsr

public ReportServiceRequest getRsr()

setRsr

public void setRsr(ReportServiceRequest rsr)

getRs

public ReportServiceResponse getRs()

setRs

public void setRs(ReportServiceResponse rs)

getClientReferenceId

public java.lang.String getClientReferenceId()

Returns the client reference id used in web service calls.

Returns:

the client reference id used in web service calls.

setClientReferenceId

public void setClientReferenceId(java.lang.String clientReferenceId)

Sets the client reference id used in web service calls. This reference can be used to make web service calls specific to client organisations. If this is not set, all web service calls will relate to the default (primary or parent) organisation. Note that if the Client Organisations configuration parameter is not turned on on the server, this has no effect.

Parameters:

clientReferenceId - the client reference id to use in web service calls

getErrorCode

public java.lang.Integer getErrorCode()

setErrorCode

public void setErrorCode(java.lang.Integer errorCode)