|
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.BIInstanceMBean.description", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") public interface BIInstanceMBean
Defines an MBean interface for managing 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.
Nested Class Summary | |
---|---|
static class |
BIInstanceMBean.ServiceState
Enumerates the different running states of the BI Instance. |
Method Summary | |
---|---|
javax.management.ObjectName |
getAvailabilityConfiguration()
Returns the object name of an mbean for managing the availability configuration of the BI Instance. |
javax.management.ObjectName |
getEmailConfiguration()
Returns the object name of an mbean for managing the email configuration of the BI Instance. |
javax.management.ObjectName |
getEssbaseConfiguration()
Returns the object name of an mbean for managing the essbase configuration of the BI Instance. |
BIInstanceMBean.ServiceState |
getJavaComponentStatus(java.lang.String naturalComponentName)
Returns the the status of the deployed component. |
javax.management.ObjectName |
getLogConfiguration()
Returns the object name of an mbean for managing the log configuration of the BI Instance. |
javax.management.ObjectName |
getMarketingConfiguration()
Returns the object name of an mbean for managing the marketing configuration of the BI Instance. |
java.lang.String |
getName()
Returns the name of the BI Instance. |
javax.management.ObjectName |
getPerformanceConfiguration()
Returns the object name of an mbean for managing the performance configuration of the BI Instance. |
javax.management.ObjectName |
getPresentationConfiguration()
Returns the object name of an mbean for managing the presentation configuration of the BI Instance. |
javax.management.ObjectName |
getPresentationServerConfiguration()
Returns the object name of an mbean for managing the presentation server configuration of the BI Instance. |
javax.management.ObjectName |
getSchedulerDatabaseConfiguration()
Returns the object name of the mbean for managing the scheduler database configuration. |
javax.management.ObjectName |
getSecurityConfiguration()
Returns the object name of an mbean for managing the security configuration of the BI Instance. |
javax.management.ObjectName |
getServerConfiguration()
Returns the object name of an mbean for managing the server configuration of the BI Instance. |
BIInstanceMBean.ServiceState |
getServiceStatus()
Returns the running status of the BI Instance. |
void |
start()
Starts the BI Instance. |
oracle.bi.management.events.EventLog |
start(java.lang.String exceptionThreshold)
Starts the BI Instance. |
void |
startJavaComponents()
Starts the BI Java components deployed to the BI domain. |
void |
startSystemComponents()
Starts the BI System components deployed to the BI domain. |
void |
stop()
Stops the BI Instance so no further requests will be serviced. |
oracle.bi.management.events.EventLog |
stop(java.lang.String exceptionThreshold)
Stops the BI Instance so no further requests will be serviced. |
void |
stopJavaComponents()
Stops the BI Java components deployed to the BI domain. |
void |
stopSystemComponents()
Stops the BI System components deployed to the BI domain. |
Method Detail |
---|
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.Name", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getName()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.PerformanceConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getPerformanceConfiguration()
PerformanceConfigurationMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.PresentationConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getPresentationConfiguration()
PresentationConfigurationMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.MarketingConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getMarketingConfiguration()
MarketingConfigurationMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.EmailConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getEmailConfiguration()
EmailConfigurationMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.ServerConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getServerConfiguration()
ServerConfigurationMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.PresentationServerConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getPresentationServerConfiguration()
PresentationServerConfigurationMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.AvailabilityConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getAvailabilityConfiguration()
AvailabilityConfigurationMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.SchedulerDatabaseConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getSchedulerDatabaseConfiguration()
SchedulerDatabaseMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.SecurityConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getSecurityConfiguration()
PresentationConfigurationMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.EssbaseConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getEssbaseConfiguration()
EssbaseConfigurationMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.LogConfiguration", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getLogConfiguration()
BILogConfigurationMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.ServiceStatus", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") BIInstanceMBean.ServiceState getServiceStatus()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.stop_arg", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") oracle.bi.management.events.EventLog stop(@Name(value="exceptionThreshold(NONE/WARNING/ERROR)") java.lang.String exceptionThreshold) throws 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.
javax.management.OperationsException
- (if exceptionThreshold is not NONE)
and if BI Instance was not successfully stopped, or any other exceptions occur.@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.stop", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") void stop() throws javax.management.OperationsException
stop(String)
.
javax.management.OperationsException
- if the BI Instance was not successfully
stopped.@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.start_arg", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") oracle.bi.management.events.EventLog start(@Name(value="exceptionThreshold(NONE/WARNING/ERROR)") java.lang.String exceptionThreshold) throws 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.
javax.management.OperationsException
- (if exceptionThreshold is not NONE)
and if the BI Instance was not fully and
successfully started. Note that the exception will be thrown if any
component fails to start up so it may be appropriate to treat this as a
warning condition rather than a failure. The service status will indicate
whether any processes started.@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.start", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") void start() throws javax.management.OperationsException
start(String)
.
javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.stopSystemComponents", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") void stopSystemComponents() throws javax.management.OperationsException
javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.startSystemComponents", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") void startSystemComponents() throws javax.management.OperationsException
javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.stopJavaComponents", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") void stopJavaComponents() throws javax.management.OperationsException
javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.startJavaComponents", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") void startJavaComponents() throws javax.management.OperationsException
javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceMBean.getJavaComponentStatus", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") BIInstanceMBean.ServiceState getJavaComponentStatus(@Name(value="naturalComponentName") java.lang.String naturalComponentName) throws javax.management.OperationsException
naturalComponentName
- The natural (without version part) name of the
java deployment.
javax.management.OperationsException
|
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 |