oracle.bi.management.adminservices.mbeans
Interface EssbaseConfigurationMBean

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

Provides an MBean interface for configuring a number of options which affect Essbase system components. 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.

Since:

11.1.1.5.53

Version:

$Header: bifndn/middleware/sysman/adminservices/mbeans/src/oracle/bi/management/adminservices/mbeans/EssbaseConfigurationMBean.java /main/8 2012/08/23 09:59:49 coneill Exp $

Author:

coneill

Method Summary

java.lang.String	getEssbaseClusterName() Get the Cluster name used by the Essbase Agent(s), assuming there is only a single cluster (which is true for 11.1.1.6.0 systems).
java.lang.String	getSharedFolderPath() Returns the shared folder to be used by Essbase when in HA mode.
boolean	isApplicationsEnabled() Private API that returns true if Essbase applications management is enabled.
boolean	isEnabled() Returns true if Essbase management is enabled
void	setEnabled(boolean enabled) Switches Essbase Systems Management (JMX & EM) functionality on and off.
void	setEssbaseClusterName(java.lang.String essbaseClusterName) Set the Cluster name used by the Essbase Agent(s), assuming there is only a single cluster (which is true for 11.1.1.6.0 systems).
void	setSharedFolderPath(java.lang.String path) Sets the shared folder to be used by Essbase when in HA mode.

Method Detail

getSharedFolderPath

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EssbaseConfigurationMBean.SharedFolderPath",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getSharedFolderPath()

Returns the shared folder to be used by Essbase when in HA mode.

setSharedFolderPath

void setSharedFolderPath(java.lang.String path)

Sets the shared folder to be used by Essbase when in HA mode.

isEnabled

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EssbaseConfigurationMBean.Enabled",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isEnabled()

Returns true if Essbase management is enabled

Returns:

true if Essbase Enabled

Since:

11.1.1.5.58 domain MBeans version

setEnabled

void setEnabled(boolean enabled)

Switches Essbase Systems Management (JMX & EM) functionality on and off. To be invoked by installer. Essbase functionality is switched OFF unless the system was installed with Essbase.

Since:

11.1.1.5.59

isApplicationsEnabled

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EssbaseConfigurationMBean.ApplicationsEnabled",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isApplicationsEnabled()

Private API that returns true if Essbase applications management is enabled.

Returns:

true if Essbase applications are enabled

Since:

11.1.1.5.60 domain MBeans version

getEssbaseClusterName

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EssbaseConfigurationMBean.ClusterName",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getEssbaseClusterName()

Get the Cluster name used by the Essbase Agent(s), assuming there is only a single cluster (which is true for 11.1.1.6.0 systems).

Returns:

Cluster Name

Since:

11.1.1.6.52

setEssbaseClusterName

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EssbaseConfigurationMBean.ClusterName",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
void setEssbaseClusterName(java.lang.String essbaseClusterName)

Set the Cluster name used by the Essbase Agent(s), assuming there is only a single cluster (which is true for 11.1.1.6.0 systems).

Parameters:

essbaseClusterName - Cluster Name

Since:

11.1.1.6.57