oracle.bi.management.adminservices.mbeans
Interface PerformanceConfigurationMBean

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.description",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
public interface PerformanceConfigurationMBean

Defines an MBean interface for managing the performance configuration of a BI Instance. To ensure that exceptions are correctly reported in clients such as JConsole, which typically do not have BIEE jars, only standard exceptions are surfaced here.

Method Summary

int	getColumnInfoMaxCacheLifetime() Deprecated. This method was created erroneously; see getMaxCacheEntries instead.
java.lang.String	getGlobalCacheStoragePath() Gets the Global Cache storage path to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.
int	getGlobalCacheStorageSize() Gets the Global Cache storage size to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.
int	getGlobalCacheStorageSizeMax() Returns the max range of Global Cache storage size to use when BI Server cache is enabled;
java.lang.String	getGlobalCacheStorageUnits() Gets the Global Cache storage size units to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.
int	getMaxCacheEntries() Gets the maximum number of cache entries; used to tune cache performance.
int	getMaxCacheEntriesMax() Returns the max range of the maximum number of cache entries; used to tune cache performance.
int	getMaxIndividualCacheEntrySize() Gets the maximum size (in megabytes) for individual server cache entries.
int	getMaxIndividualCacheEntrySizeMax() Returns the max range of the maximum size (in megabytes) for individual server cache entries.
int	getMaxNumRowsInTableView() Gets the maximum number of rows of data to include in table views.
int	getMaxNumRowsInTableViewMax() Gets the maximum number of rows of data to include in table views.
int	getMaxNumRowsPerEmailPage() Gets the maximum number of rows of data to include in delivered emails.
int	getMaxNumRowsPerEmailPageMax() Gets the maximum number of rows of data to include in delivered emails max range
int	getMaxNumRowsToExcel() Gets the maximum number of rows to export to excel.
int	getMaxNumRowsToExcelMax() Gets the maximum number of rows to export to excel max range.
int	getUserSessionExpiry() Returns the user session expiry in minutes.
int	getUserSessionExpiryMax() Returns the user session expiry in minutes max range.
boolean	isBIServerCacheEnabled() Indicates whether or not the BI Server cache is enabled.
boolean	isOnlineRPDUpdatesDisallowed() Indicates whether or not online updates to the rpd is allowed.
void	setBIServerCacheEnabled(boolean b) Sets whether or not the BI Server cache is enabled.
void	setColumnInfoMaxCacheLifetime(int n) Deprecated. This method was created erroneously; see setMaxCacheEntries instead.
void	setGlobalCacheStoragePath(java.lang.String globalCacheStoragePath) Sets the Global Cache storage path to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.
void	setGlobalCacheStorageSize(int globalCacheStorageSize) Sets the Global Cache storage size to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.
void	setGlobalCacheStorageUnits(java.lang.String globalCacheStorageUnits) Sets the Global Cache storage size units to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.
void	setMaxCacheEntries(int maxCacheEntries) Sets the maximum number of cache entries; used to tune cache performance.
void	setMaxIndividualCacheEntrySize(int n) Sets the maximum size (in megabytes) for individual server cache entries.
void	setMaxNumRowsInTableView(int n) Sets the maximum number of rows of data to include in table views.
void	setMaxNumRowsPerEmailPage(int n) Sets the maximum number of rows of data to include in delivered emails.
void	setMaxNumRowsToExcel(int n) Sets the maximum number of rows to export to excel.
void	setOnlineRPDUpdatesDisallowed(boolean b) Sets whether or not online updates to the rpd is allowed.
void	setUserSessionExpiry(int n) Sets the user session expiry in minutes.

Method Detail

getUserSessionExpiry

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.UserSessionExpiry",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getUserSessionExpiry()

Returns the user session expiry in minutes.

setUserSessionExpiry

void setUserSessionExpiry(int n)
                          throws java.lang.IllegalArgumentException

Sets the user session expiry in minutes.

Throws:

java.lang.IllegalArgumentException

getMaxNumRowsToExcel

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.MaxNumRowsToExcel",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxNumRowsToExcel()

Gets the maximum number of rows to export to excel.

setMaxNumRowsToExcel

void setMaxNumRowsToExcel(int n)
                          throws java.lang.IllegalArgumentException

Sets the maximum number of rows to export to excel.

Throws:

java.lang.IllegalArgumentException

getMaxNumRowsPerEmailPage

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.MaxNumRowsPerEmailPage",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxNumRowsPerEmailPage()

Gets the maximum number of rows of data to include in delivered emails.

setMaxNumRowsPerEmailPage

void setMaxNumRowsPerEmailPage(int n)
                               throws java.lang.IllegalArgumentException

Sets the maximum number of rows of data to include in delivered emails.

Throws:

java.lang.IllegalArgumentException

getMaxNumRowsInTableView

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.MaxNumRowsInTableView",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxNumRowsInTableView()

Gets the maximum number of rows of data to include in table views.

setMaxNumRowsInTableView

void setMaxNumRowsInTableView(int n)
                              throws java.lang.IllegalArgumentException

Sets the maximum number of rows of data to include in table views.

Throws:

java.lang.IllegalArgumentException

getMaxIndividualCacheEntrySize

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.MaxIndividualCacheEntrySize",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxIndividualCacheEntrySize()

Gets the maximum size (in megabytes) for individual server cache entries.

setMaxIndividualCacheEntrySize

void setMaxIndividualCacheEntrySize(int n)
                                    throws java.lang.IllegalArgumentException

Sets the maximum size (in megabytes) for individual server cache entries.

Throws:

java.lang.IllegalArgumentException

isOnlineRPDUpdatesDisallowed

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.OnlineRPDUpdatesDisallowed",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isOnlineRPDUpdatesDisallowed()

Indicates whether or not online updates to the rpd is allowed.

setOnlineRPDUpdatesDisallowed

void setOnlineRPDUpdatesDisallowed(boolean b)

Sets whether or not online updates to the rpd is allowed.

getColumnInfoMaxCacheLifetime

@Deprecated
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.deprecated",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getColumnInfoMaxCacheLifetime()

Deprecated. This method was created erroneously; see getMaxCacheEntries instead.

Gets the maximum number of minutes to retains column information in cache.

See Also:

getMaxCacheEntries()

setColumnInfoMaxCacheLifetime

@Deprecated
void setColumnInfoMaxCacheLifetime(int n)
                                   throws java.lang.IllegalArgumentException

Deprecated. This method was created erroneously; see setMaxCacheEntries instead.

Sets the maximum number of minutes to retain column information in cache.

Throws:

java.lang.IllegalArgumentException

See Also:

setMaxCacheEntries(int)

getMaxCacheEntries

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.MaxCacheEntries",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxCacheEntries()

Gets the maximum number of cache entries; used to tune cache performance.

setMaxCacheEntries

void setMaxCacheEntries(int maxCacheEntries)
                        throws java.lang.IllegalArgumentException

Sets the maximum number of cache entries; used to tune cache performance.

Throws:

java.lang.IllegalArgumentException

isBIServerCacheEnabled

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.BIServerCacheEnabled",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isBIServerCacheEnabled()

Indicates whether or not the BI Server cache is enabled.

setBIServerCacheEnabled

void setBIServerCacheEnabled(boolean b)

Sets whether or not the BI Server cache is enabled.

getGlobalCacheStoragePath

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.GlobalCacheStoragePath",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getGlobalCacheStoragePath()

Gets the Global Cache storage path to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.

setGlobalCacheStoragePath

void setGlobalCacheStoragePath(java.lang.String globalCacheStoragePath)

Sets the Global Cache storage path to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.

getGlobalCacheStorageSize

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.GlobalCacheStorageSize",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getGlobalCacheStorageSize()

Gets the Global Cache storage size to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.

setGlobalCacheStorageSize

void setGlobalCacheStorageSize(int globalCacheStorageSize)
                               throws java.lang.IllegalArgumentException

Sets the Global Cache storage size to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.

Throws:

java.lang.IllegalArgumentException

getGlobalCacheStorageUnits

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.GlobalCacheStorageUnits",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getGlobalCacheStorageUnits()

Gets the Global Cache storage size units to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.

Returns:

Valid units are "KB", "MB", "GB".

setGlobalCacheStorageUnits

void setGlobalCacheStorageUnits(java.lang.String globalCacheStorageUnits)

Sets the Global Cache storage size units to use when BI Server cache is enabled; note that this is mandatory when BI server is clustered.

Parameters:

globalCacheStorageUnits - Valid units are "KB", "MB", "GB".

getMaxIndividualCacheEntrySizeMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.MaxIndividualCacheEntrySizeMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxIndividualCacheEntrySizeMax()

Returns the max range of the maximum size (in megabytes) for individual server cache entries.

getMaxCacheEntriesMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.MaxCacheEntriesMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxCacheEntriesMax()

Returns the max range of the maximum number of cache entries; used to tune cache performance.

getGlobalCacheStorageSizeMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.GlobalCacheStorageSizeMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getGlobalCacheStorageSizeMax()

Returns the max range of Global Cache storage size to use when BI Server cache is enabled;

getUserSessionExpiryMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.UserSessionExpiryMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getUserSessionExpiryMax()

Returns the user session expiry in minutes max range.

getMaxNumRowsInTableViewMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.MaxNumRowsInTableViewMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxNumRowsInTableViewMax()

Gets the maximum number of rows of data to include in table views.

getMaxNumRowsToExcelMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.MaxNumRowsToExcel",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxNumRowsToExcelMax()

Gets the maximum number of rows to export to excel max range.

getMaxNumRowsPerEmailPageMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.PerformanceConfigurationMBean.MaxNumRowsPerEmailPageMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxNumRowsPerEmailPageMax()

Gets the maximum number of rows of data to include in delivered emails max range