oracle.bi.management.adminservices.mbeans
Interface BIInstanceDeploymentMBean

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

Defines an MBean interface to describe the deployment (provisioning) of a BI Instance to 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

javax.management.ObjectName	getBIInstance() Returns the object name of the mbean which represents the BI instance which has been deployed.
java.lang.String	getBIInstanceName() Returns the name of the BI Instance.
javax.management.ObjectName[]	getComponents() Returns an array of object names for the BI process components that have been instantiated for the BI Instance/Oracle Instance combination.
java.lang.String	getListenAddress() Return the host name or ip address that all listening ports are bound to for components of this deployment.
int	getNumBIServers() Returns the number of BI Servers instantiated for the BI Instance within the Oracle Instance.
int	getNumBIServersMax() Returns the max range of number of BI Servers
int	getNumClusterControllers() Returns the number of Cluster Controllers instantiated for the BI Instance within the Oracle Instance.
int	getNumClusterControllersMax() Returns the max range of number of Cluster Controllers
int	getNumEssbaseAgents() Returns the number of Essbase agents instantiated for the BI Instance within the Oracle Instance.
int	getNumEssbaseAgentsMax() Returns the max range of number of Essbase Agents instantiated
int	getNumJavahosts() Returns the number of Javahosts instantiated for the BI Instance within the Oracle Instance.
int	getNumJavahostsMax() Returns the max range of number of Javahosts
int	getNumPresentationServers() Returns the number of Presentation Servers instantiated for the BI Instance within the Oracle Instance.
int	getNumPresentationServersMax() Returns the max range of number of Presentation Servers
int	getNumSchedulers() Returns the number of Schedulers instantiated for the BI Instance within the Oracle Instance.
int	getNumSchedulersMax() Returns the max range of number of Schedulers instantiated
javax.management.ObjectName	getOracleInstance() Returns the object name of the mbean which represents the oracle instance within which BI Component has been deployed.
int	getPortRangeEnd() Returns the end of the port range to use for components of this deployment.
int	getPortRangeStart() Returns the start of the port range to use for components of this deployment.
void	setListenAddress(java.lang.String address) Set the host name or ip address that all listening ports are bound to for components of this deployment.
void	setNumBIServers(int n) Sets the number of BI Servers instantiated for the BI Instance within the Oracle Instance.
void	setNumClusterControllers(int n) Sets the number of Cluster Controllers instantiated for the BI Instance within the Oracle Instance.
void	setNumEssbaseAgents(int n) Sets the number of Essbase agents instantiated for the BI Instance within the Oracle Instance.
void	setNumJavahosts(int n) Sets the number of Javahosts instantiated for the BI Instance within the Oracle Instance.
void	setNumPresentationServers(int n) Sets the number of Presentation Servers instantiated for the BI Instance within the Oracle Instance.
void	setNumSchedulers(int n) Sets the number of Schedulers instantiated for the BI Instance within the Oracle Instance.
void	setPortRangeEnd(int n) Sets the end of the port range to use for components of this deployment.
void	setPortRangeStart(int n) Sets the start of the port range to use for components of this deployment.

Method Detail

getOracleInstance

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.OracleInstance",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
javax.management.ObjectName getOracleInstance()

Returns the object name of the mbean which represents the oracle instance within which BI Component has been deployed.

getBIInstance

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.BIInstance",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
javax.management.ObjectName getBIInstance()

Returns the object name of the mbean which represents the BI instance which has been deployed.

See Also:

BIInstanceMBean

getBIInstanceName

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.BIInstanceName",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getBIInstanceName()

Returns the name of the BI Instance.

getPortRangeStart

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.PortRangeStart",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getPortRangeStart()

Returns the start of the port range to use for components of this deployment.

setPortRangeStart

void setPortRangeStart(int n)
                       throws java.lang.IllegalArgumentException

Sets the start of the port range to use for components of this deployment.

Throws:

java.lang.IllegalArgumentException - if the specified number is less than 0.

getPortRangeEnd

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.PortRangeEnd",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getPortRangeEnd()

Returns the end of the port range to use for components of this deployment.

setPortRangeEnd

void setPortRangeEnd(int n)
                     throws java.lang.IllegalArgumentException

Sets the end of the port range to use for components of this deployment.

Throws:

java.lang.IllegalArgumentException - if the specified number is less than 0.

getNumBIServers

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumBIServers",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumBIServers()

Returns the number of BI Servers instantiated for the BI Instance within the Oracle Instance.

See Also:

OracleInstanceMBean

setNumBIServers

void setNumBIServers(int n)
                     throws java.lang.IllegalArgumentException

Sets the number of BI Servers instantiated for the BI Instance within the Oracle Instance.

Throws:

java.lang.IllegalArgumentException - if the specified number is less than 0.

getNumPresentationServers

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumPresentationServers",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumPresentationServers()

Returns the number of Presentation Servers instantiated for the BI Instance within the Oracle Instance.

setNumPresentationServers

void setNumPresentationServers(int n)
                               throws java.lang.IllegalArgumentException

Sets the number of Presentation Servers instantiated for the BI Instance within the Oracle Instance.

Throws:

java.lang.IllegalArgumentException - if the specified number is less than 0.

getNumJavahosts

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumJavahosts",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumJavahosts()

Returns the number of Javahosts instantiated for the BI Instance within the Oracle Instance.

setNumJavahosts

void setNumJavahosts(int n)
                     throws java.lang.IllegalArgumentException

Sets the number of Javahosts instantiated for the BI Instance within the Oracle Instance.

Throws:

java.lang.IllegalArgumentException - if the specified number is less than 0.

getNumClusterControllers

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumClusterControllers",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumClusterControllers()

Returns the number of Cluster Controllers instantiated for the BI Instance within the Oracle Instance.

setNumClusterControllers

void setNumClusterControllers(int n)
                              throws java.lang.IllegalArgumentException

Sets the number of Cluster Controllers instantiated for the BI Instance within the Oracle Instance.

Throws:

java.lang.IllegalArgumentException - if the specified number is less than 0 or greater than 1. The total number of cluster controllers across all oracle instances (for this BI Instance) must not be greater than 2, but this is validated at commit time.

getNumSchedulers

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumSchedulers",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumSchedulers()

Returns the number of Schedulers instantiated for the BI Instance within the Oracle Instance.

setNumSchedulers

void setNumSchedulers(int n)
                      throws java.lang.IllegalArgumentException

Sets the number of Schedulers instantiated for the BI Instance within the Oracle Instance.

Throws:

java.lang.IllegalArgumentException - if the specified number is less than 0 or greater than 1. The total number of schedulers across all oracle instances (for this BI Instance) must not be greater than 2, but this is validated at commit time.

getNumEssbaseAgents

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumEssbaseAgents",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumEssbaseAgents()

Returns the number of Essbase agents instantiated for the BI Instance within the Oracle Instance.

Since:

11.1.1.5.50

setNumEssbaseAgents

void setNumEssbaseAgents(int n)
                         throws java.lang.IllegalArgumentException

Sets the number of Essbase agents instantiated for the BI Instance within the Oracle Instance.

Throws:

java.lang.IllegalArgumentException - if the specified number is less than 0

Since:

11.1.1.5.50

getListenAddress

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.ListenAddress",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getListenAddress()

Return the host name or ip address that all listening ports are bound to for components of this deployment. A value of "*" means that ports will be bound to ALL available interfaces.

Returns:

setListenAddress

void setListenAddress(java.lang.String address)
                      throws java.lang.IllegalArgumentException

Set the host name or ip address that all listening ports are bound to for components of this deployment. A value of "*" means that ports will be bound to ALL available interfaces.

Parameters:

address -

Throws:

java.lang.IllegalArgumentException

getComponents

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.Components",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
javax.management.ObjectName[] getComponents()

Returns an array of object names for the BI process components that have been instantiated for the BI Instance/Oracle Instance combination.

See Also:

BIComponentMBean

getNumBIServersMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumBIServersMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumBIServersMax()

Returns the max range of number of BI Servers

getNumPresentationServersMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumPresentationServersMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumPresentationServersMax()

Returns the max range of number of Presentation Servers

getNumJavahostsMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumJavahostsMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumJavahostsMax()

Returns the max range of number of Javahosts

getNumClusterControllersMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumClusterControllersMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumClusterControllersMax()

Returns the max range of number of Cluster Controllers

getNumSchedulersMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumSchedulersMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumSchedulersMax()

Returns the max range of number of Schedulers instantiated

getNumEssbaseAgentsMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIInstanceDeploymentMBean.NumEssbaseAgentsMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getNumEssbaseAgentsMax()

Returns the max range of number of Essbase Agents instantiated

Since:

11.1.1.5.50