|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Enterprise Edition Systems Management 11g Release 1(11.1.1) E16455-05 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@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 |
getCentralConfigurationPublishingDirectory()
Gets the external central configuration publishing directory. |
java.lang.String |
getFrontEndLoadBalancerBaseURL()
Gets the manually configured public facing base URL to be used when embedding links back to BI content when views are built offline (e.g., via scheduled agents) |
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. |
boolean |
isProcessProvisioningEnabled()
Returns whether Process Provisioning 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 |
setCentralConfigurationPublishingDirectory(java.lang.String publishingDir)
Sets the external central configuration publishing directory. |
void |
setFrontEndLoadBalancerBaseURL(java.lang.String url)
Manually sets the configured public facing base URL to be used when embedding links back to BI content when views are built offline (e.g., via scheduled agents). |
void |
setHardwareAcceleration(boolean hardwareAcceleration)
Sets whether hardware acceleration is enabled. |
void |
setOPMNClusteringEnabled(boolean isOPMNClusteringEnabled)
This sets the start of OPMN clustering. |
void |
setProcessProvisioningEnabled(boolean processProvisioningEnabled)
Sets whether Process Provisioning is enabled. |
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 |
---|
@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
java.lang.IllegalStateException
- if the domain mbean is locked.
java.io.IOException
- if it's not possible to read the underlying config file.@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.Locked", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") boolean isLocked()
getLockOwner()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.LockOwner", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getLockOwner()
@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
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.@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
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.@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
exceptionThreshold
- If set to "NONE",
will not raise an exception;
instead will fill the EventLog with information.Level.SEVERE
for errors, or Level.WARNING
for warnings,
plus some INFO level and lower informational messages.
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.@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
commit(String)
.
java.lang.IllegalStateException
java.io.IOException
javax.management.OperationsException
@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
commit(String)
.
java.lang.IllegalStateException
java.io.IOException
javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.BIInstances", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName[] getBIInstances()
BIInstanceMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.OracleInstances", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName[] getOracleInstances()
OracleInstanceMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.discoverProcessConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") int discoverProcessConfiguration() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- if there is no current lock on the domain
owned by the current user.@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.AppRestartNeeded", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") boolean isAppRestartNeeded()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.AppRestartNeeded", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") void setAppRestartNeeded(boolean isAppRestartNeeded)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.ProductVersionString", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getProductVersionString()
11.1.1.2.0
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.ProductVersionLabel", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getProductVersionLabel()
PRODUCTNAME_BRANCHNAME_OSNAME_LABELNAME
,
where LABELNAME
is YYMMDD[.HHMM][.Suffix]
BIFNDN_PT.MW_NT_090813.1000.S
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.ProductVersionBuild", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getProductVersionBuild()
YYYYMMDD_nnn
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.CentralConfigurationEnabled", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") boolean isCentralConfigurationEnabled()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.CentralConfigurationCorrupt", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") boolean isCentralConfigurationCorrupt()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.HardwareAcceleration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") boolean isHardwareAcceleration()
void setHardwareAcceleration(boolean hardwareAcceleration)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.TestMode", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getTestMode()
void setTestMode(java.lang.String testMode) throws javax.management.OperationsException
testMode
- testMode
javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.OPMNClusterEnabled", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") boolean isOPMNClusteringEnabled()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.OPMNClusterEnabled", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") void setOPMNClusteringEnabled(boolean isOPMNClusteringEnabled)
isOPMNClusteringEnabled
- isOPMNClusteringEnabled@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.ProcessProvisioningEnabled", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") boolean isProcessProvisioningEnabled()
void setProcessProvisioningEnabled(boolean processProvisioningEnabled)
processProvisioningEnabled
- true if provisioning is enabled.@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.CentralConfigurationPublishingDirectory", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getCentralConfigurationPublishingDirectory()
void setCentralConfigurationPublishingDirectory(java.lang.String publishingDir)
publishingDir
- the path to the directory that config files should be copied to@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIDomainMBean.FrontEndLoadBalancerBaseURL", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getFrontEndLoadBalancerBaseURL()
void setFrontEndLoadBalancerBaseURL(java.lang.String url)
url
-
|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Enterprise Edition Systems Management 11g Release 1(11.1.1) E16455-05 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |