Skip navigation links

oracle.bi.management.adminservices.mbeans
Interface OracleInstanceMBean

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

Defines an MBean interface for managing an Oracle 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

void	deprovisionBIInstance(java.lang.String biInstanceName) Deprovisions (de-associates) the BI Instance with the specified name from the Oracle Instance.
javax.management.ObjectName[]	getBIInstanceDeployments() Returns an array of object names for the set of BI Instances which have been deployed (provisioned) to this Oracle Instance.
java.lang.String	getHost() Returns the host of the Oracle Instance.
java.lang.String	getId() Returns the id of the Oracle Instance.
java.lang.String	getInstanceHome() Returns the path to the Oracle Instance on its containing host.
void	provisionBIInstance(java.lang.String biInstanceName) Provisions (associates) the BI Instance with the specified name to the Oracle Instance.

Method Detail

getHost

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.OracleInstanceMBean.Host",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getHost()

Returns the host of the Oracle Instance.

getInstanceHome

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.OracleInstanceMBean.InstanceHome",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getInstanceHome()

Returns the path to the Oracle Instance on its containing host.

getId

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.OracleInstanceMBean.Id",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getId()

Returns the id of the Oracle Instance. Note that this is not a unique identifier across the domain.

getBIInstanceDeployments

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.OracleInstanceMBean.BIInstanceDeployments",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
javax.management.ObjectName[] getBIInstanceDeployments()

Returns an array of object names for the set of BI Instances which have been deployed (provisioned) to this Oracle Instance.

See Also:

BIInstanceDeploymentMBean

provisionBIInstance

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.OracleInstanceMBean.provisionBIInstance",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void provisionBIInstance(@Name(value="biInstanceName")
                                     java.lang.String biInstanceName)
                         throws javax.management.OperationsException,
                                java.lang.IllegalArgumentException

Provisions (associates) the BI Instance with the specified name to the Oracle Instance. Associating the BI Instance to the Oracle Instance is a prerequisite for scaling the BI Instance out to the Oracle Instance.

Parameters:

biInstanceName - The name of a BI Instance.

Throws:

javax.management.OperationsException - if the BI Instance is already provisioned to the Oracle Instance.

java.lang.IllegalArgumentException - if no BI Instance exists with the specified name.

deprovisionBIInstance

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.OracleInstanceMBean.deprovisionBIInstance",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void deprovisionBIInstance(@Name(value="biInstanceName")
                                       java.lang.String biInstanceName)
                           throws javax.management.OperationsException,
                                  java.lang.IllegalArgumentException

Deprovisions (de-associates) the BI Instance with the specified name from the Oracle Instance. When this change is committed all process components within the Oracle Instance and belonging to the specified BI Instance will be deleted from the system.

Parameters:

biInstanceName - The name of a BI Instance.

Throws:

BIInstanceNotDeployedException - if the BI Instance is not provisioned to the Oracle Instance.

javax.management.OperationsException - if no BI Instance exists with the specified name.

java.lang.IllegalArgumentException

Skip navigation links