Skip navigation links

oracle.bi.management.adminservices.mbeans
Interface BIDomainMBean

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.description",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
public interface BIDomainMBean

Defines an MBean interface for managing a BI Domain. This interface provides a root entry point to the admin management services. Clients may not have acceess to BIEE jars. Therefore only standard Exceptions are thrown (either directly or as chained exception causes). OperationsException is used to represent BIEE specific exceptions.

Method Summary

oracle.bi.management.events.EventLog	commit() Same as commit("ERROR"), so raises exceptions if an error occurred.
oracle.bi.management.events.EventLog	commit(java.lang.String exceptionThreshold) Saves any changes made to the domain and releases the lock.
int	discoverProcessConfiguration() Discards the current process configuration stored in the central BI config file and reconstructs it from OPMN's state.
javax.management.ObjectName[]	getBIInstances() Returns the collection of object names for the MBeans which represent BI Instances.
java.lang.String	getLockOwner() Gets the identity of the person who owns the edit lock.
javax.management.ObjectName[]	getOracleInstances() Returns the collection of object names for the MBeans which represent Oracle Instances.
java.lang.String	getProductVersionBuild() Return the build date and number used to build this product.
java.lang.String	getProductVersionLabel() Return the version label used to build this product.
java.lang.String	getProductVersionString() Return the version string for this product's API.
java.lang.String	getTestMode() Returns the private test settings; not for public use.
boolean	isAppRestartNeeded() Indicates whether an application restart (for the whole domain) is needed.
boolean	isCentralConfigurationCorrupt() Returns whether Central Configuration is corrupt and failed to be read correctly.
boolean	isCentralConfigurationEnabled() Returns whether Central Configuration is enabled or not.
boolean	isHardwareAcceleration() Returns whether hardware acceleration is enabled.
boolean	isLocked() Indicates whether the domain is locked for editing.
boolean	isOPMNClusteringEnabled() Returns whether OPMN Clustering is enabled.
void	lock() Obtains an exclusive lock for managing the domain.
void	refresh() Refreshes the domain mbean from the state persisted in the underlying config file.
void	rollback() Rolls back any changes made to the domain since the lock was obtained and releases the lock.
void	setAppRestartNeeded(boolean isAppRestartNeeded) Sets whether an application restart is needed.
void	setHardwareAcceleration(boolean hardwareAcceleration) Sets whether hardware acceleration is enabled.
void	setOPMNClusteringEnabled(boolean isOPMNClusteringEnabled) This sets the start of OPMN clustering.
void	setTestMode(java.lang.String testMode) Set private test settings; not for public use.
void	simpleCommit() Provides a simpler commit api which makes commit problems easier to process for simple clients (eg WLST).

Method Detail

refresh

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.refresh",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void refresh()
             throws java.lang.IllegalStateException,
                    java.io.IOException

Refreshes the domain mbean from the state persisted in the underlying config file.

Throws:

java.lang.IllegalStateException - if the domain mbean is locked.

java.io.IOException - if it's not possible to read the underlying config file.

isLocked

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.Locked",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isLocked()

Indicates whether the domain is locked for editing.

Returns:

true if there is currently an exclusive lock active for the domain. Note that a true return result does not necessarily mean that the current user owns the domain lock.

See Also:

getLockOwner()

getLockOwner

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.LockOwner",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getLockOwner()

Gets the identity of the person who owns the edit lock.

Returns:

Returns the lock owner or null if there is no lock currently active.

lock

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.lock",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void lock()
          throws java.lang.IllegalStateException,
                 java.security.AccessControlException,
                 java.io.IOException

Obtains an exclusive lock for managing the domain. Only one person may have a lock for managing the domain. The MBean state will be automatically refreshed as part of obtaining the lock.

Throws:

java.lang.IllegalStateException - if the domain is already locked.

java.security.AccessControlException - if the current user does not have the appropriate privilege for obtaining a lock.

java.io.IOException - if a problem occurs refreshing the state of the mbean.

rollback

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.rollback",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void rollback()
              throws java.lang.IllegalStateException,
                     java.io.IOException

Rolls back any changes made to the domain since the lock was obtained and releases the lock.

Throws:

java.lang.IllegalStateException - if there is no current lock on the domain owned by the current user.

java.io.IOException - if it's not possible to read the underlying config file.

commit

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.commit_arg",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
oracle.bi.management.events.EventLog commit(@Name(value="exceptionThreshold(NONE/WARNING/ERROR)")
                                                        java.lang.String exceptionThreshold)
                                            throws java.lang.IllegalStateException,
                                                   java.io.IOException,
                                                   javax.management.OperationsException

Saves any changes made to the domain and releases the lock. Note that all configuration data is only re-read on application restart, so _all_ changes require a restart.

Parameters:

exceptionThreshold
- If set to "NONE", will not raise an exception; instead will fill the EventLog with information.
If set to "WARNING", will raise an exception if the eventLog contains any Errors or Warnings.
If set to "ERROR", will raise an exception if the eventLog contains any Errors.
If set to anything else, will raise IllegalArgumentException.

Returns:

An EventLog which includes entries of Level.SEVERE for errors, or Level.WARNING for warnings, plus some INFO level and lower informational messages.

Throws:

java.lang.IllegalStateException - (if exceptionThreshold is not NONE) and if there is no current lock on the domain owned by the current user.

java.io.IOException - (if exceptionThreshold is not NONE) and if the underlying BI Domain config file cannot be successfully updated.

javax.management.OperationsException - (if exceptionThreshold is not NONE) and if the state of the domain is not valid, or any other exceptions occur.

commit

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.commit",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
oracle.bi.management.events.EventLog commit()
                                            throws java.lang.IllegalStateException,
                                                   java.io.IOException,
                                                   javax.management.OperationsException

Same as commit("ERROR"), so raises exceptions if an error occurred. See commit(String).

Throws:

java.lang.IllegalStateException

java.io.IOException

javax.management.OperationsException

simpleCommit

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.simpleCommit",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void simpleCommit()
                  throws java.lang.IllegalStateException,
                         java.io.IOException,
                         javax.management.OperationsException

Provides a simpler commit api which makes commit problems easier to process for simple clients (eg WLST). Warnings and errors in the EventLog result in an OperationsException. Same as commit("WARNING"). See commit(String).

Throws:

java.lang.IllegalStateException

java.io.IOException

javax.management.OperationsException

getBIInstances

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.BIInstances",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
javax.management.ObjectName[] getBIInstances()

Returns the collection of object names for the MBeans which represent BI Instances.

See Also:

BIInstanceMBean

getOracleInstances

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.OracleInstances",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
javax.management.ObjectName[] getOracleInstances()

Returns the collection of object names for the MBeans which represent Oracle Instances.

See Also:

OracleInstanceMBean

discoverProcessConfiguration

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.discoverProcessConfiguration",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
int discoverProcessConfiguration()
                                 throws java.lang.IllegalStateException

Discards the current process configuration stored in the central BI config file and reconstructs it from OPMN's state. This method should not normally be invoked so please use with care.

Returns:

The count of the number of BIINstanceDeployments which were sucessfully processed.

Throws:

java.lang.IllegalStateException - if there is no current lock on the domain owned by the current user.

isAppRestartNeeded

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.AppRestartNeeded",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isAppRestartNeeded()

Indicates whether an application restart (for the whole domain) is needed.

setAppRestartNeeded

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.AppRestartNeeded",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void setAppRestartNeeded(boolean isAppRestartNeeded)

Sets whether an application restart is needed.

getProductVersionString

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.ProductVersionString",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getProductVersionString()

Return the version string for this product's API.

E.g. 11.1.1.2.0

Returns:

version string

getProductVersionLabel

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.ProductVersionLabel",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getProductVersionLabel()

Return the version label used to build this product.

Format: PRODUCTNAME_BRANCHNAME_OSNAME_LABELNAME, where LABELNAME is YYMMDD[.HHMM][.Suffix]
E.g. BIFNDN_PT.MW_NT_090813.1000.S

Returns:

version label

getProductVersionBuild

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.ProductVersionBuild",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getProductVersionBuild()

Return the build date and number used to build this product.

Format: YYYYMMDD_nnn

Returns:

Build date and number

isCentralConfigurationEnabled

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.CentralConfigurationEnabled",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isCentralConfigurationEnabled()

Returns whether Central Configuration is enabled or not.

isCentralConfigurationCorrupt

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.CentralConfigurationCorrupt",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isCentralConfigurationCorrupt()

Returns whether Central Configuration is corrupt and failed to be read correctly.

isHardwareAcceleration

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.HardwareAcceleration",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isHardwareAcceleration()

Returns whether hardware acceleration is enabled.

Since:

11.1.1.5.50

setHardwareAcceleration

void setHardwareAcceleration(boolean hardwareAcceleration)

Sets whether hardware acceleration is enabled.

Since:

11.1.1.5.50

getTestMode

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.TestMode",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getTestMode()

Returns the private test settings; not for public use.

Returns:

testMode

Since:

11.1.1.5.54

setTestMode

void setTestMode(java.lang.String testMode)
                 throws javax.management.OperationsException

Set private test settings; not for public use.

Parameters:

testMode - testMode

Throws:

javax.management.OperationsException

Since:

11.1.1.5.54

isOPMNClusteringEnabled

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.OPMNClusterEnabled",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isOPMNClusteringEnabled()

Returns whether OPMN Clustering is enabled.

Since:

11.1.1.5.55

setOPMNClusteringEnabled

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.OPMNClusterEnabled",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void setOPMNClusteringEnabled(boolean isOPMNClusteringEnabled)

This sets the start of OPMN clustering.

Parameters:

isOPMNClusteringEnabled - isOPMNClusteringEnabled

Since:

11.1.1.5.55

Skip navigation links